Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlkamp/litterrobot
CLI for the Litter Robot 3 Connect
https://github.com/tlkamp/litterrobot
go golang hacktoberfest iot litter-robot litterbox
Last synced: 8 days ago
JSON representation
CLI for the Litter Robot 3 Connect
- Host: GitHub
- URL: https://github.com/tlkamp/litterrobot
- Owner: tlkamp
- License: mit
- Created: 2023-09-30T22:39:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-01T18:03:19.000Z (about 1 year ago)
- Last Synced: 2024-10-27T13:11:35.130Z (about 2 months ago)
- Topics: go, golang, hacktoberfest, iot, litter-robot, litterbox
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# litterrobot
A CLI for the Litter Robot 3.
## Usage
### Top Level Commands
```console
$ litterrobot
Control your Litter Robot 3 Connect
Usage:
litterrobot [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
config Manage local configuration for the CLI
help Help about any command
version print the version information
Flags:
-h, --help help for litterrobot
Use "litterrobot [command] --help" for more information about a command.
```
### Config
> The config file is stored at `~/.litterrobot/config.yaml`. This location is not currently configurable.
Use the `config` subcommands to configure the CLI.
#### Initialize the config file
```console
$ litterrobot config init
```
#### Set a Config Value
```console
$ litterrobot config set password changeIt
```
#### Get a Config Value
```console
$ litterrobot config get password
*******
# To show sensitive values, use the --show-secret flag
$ litterrobot config get password --show-secrets
changeIt
```
#### Show all Config Values
```console
$ litterrobot config show
email: [email protected]
password: *******
# To show sensitive values, use the --show-secrets flag
$ litterrobot config show --show-secrets
email: [email protected]
password: changeIt
```
### Login
Use the `login` command to authenticate to Litter Robot.
This command writes the `token` to the config file. Keep it secret!
```console
$ litterobot login
```