-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Cooper Control Tool | ||
|
||
This is the CLI tool to control cooper | ||
|
||
## Installing | ||
|
||
You can install **cpctl** directly from PyPI: | ||
|
||
|
||
```sh | ||
sudo pip3 install -U cpctl | ||
``` | ||
|
||
> Note: You may need to use `sudo` before the command - it depends on the operating system used... | ||
## Usage | ||
|
||
This tool has built-in help system. Just run: | ||
|
||
```sh | ||
>> cpctl --help | ||
Usage: cpctl [OPTIONS] COMMAND [ARGS]... | ||
|
||
Cooper Control Tool. | ||
|
||
Options: | ||
--version Show the version and exit. | ||
-d, --device TEXT Device path. | ||
--help Show this message and exit. | ||
|
||
Commands: | ||
config Config | ||
devices Print available devices. | ||
node Manage the nodes | ||
|
||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the [**MIT License**](https://opensource.org/licenses/MIT/) - see the [**LICENSE**](LICENSE) file for details. |