# giracli

> CLI script to control a Gira home server

Latest version **1.2.0** (published 2018-09-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install giracli
pnpm add giracli
yarn add giracli
bun add giracli
```

Provides the command `gira`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2018-09-05 |
| First published | 2017-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 214.1 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jonas Friedmann |
| Maintainers | frdmn |
| Keywords | gira, home, server, control, power, light, switches |

## Links

- npm: https://www.npmjs.com/package/giracli
- Repository: https://github.com/frdmn/giraCLI
- Homepage: https://github.com/frdmn/giraCLI#readme
- Issues: https://github.com/frdmn/giraCLI/issues
- npm.io page: https://npm.io/package/giracli

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^12.0.1
- [request](https://npm.io/package/request.md) ^2.88.0
- [prettyjson](https://npm.io/package/prettyjson.md) ^1.2.1
- [node-notifier](https://npm.io/package/node-notifier.md) ^5.2.1

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2018-09-05
- 1.1.2 — 2017-01-05
- 1.1.1 — 2017-01-05
- 1.1.0 — 2017-01-05

## README

# giraCLI

![](http://i.imgur.com/K4SLIZp.png)

CLI script to control a Gira home server.

## Installation

1. Install the project using `npm`:
  `npm install -g giraCLI`
2. Create or copy the default configuration file (`~/.gira.json`):

    ```
    curl https://raw.githubusercontent.com/frdmn/giraCLI/master/gira.json -o ~/.gira.json
    ```

3. Adjust the server and outlet configuration:

    ```
    vi ~/.gira.json
    ```

## Usage

Here's a short explanation how to use `giraCLI`:

### Power on/off all configured outlets

![](http://i.imgur.com/K4SLIZp.png)

### Power on/off a specific outlet

![](http://i.imgur.com/euqYRtn.png)

### Print loaded configuration

![](http://i.imgur.com/o4NOcLk.png)

## Contributing

1. Fork it
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin feature/my-new-feature`
5. Submit a pull request

## Requirements / Dependencies

* Gira home server
* Node

## Version

1.2.0

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/giracli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._