diff --git a/README.md b/README.md index 1a1d74ee9..d1e127fc7 100644 --- a/README.md +++ b/README.md @@ -212,6 +212,12 @@ You can also specify the api host and port, and turn on authentication: You may access the [robeaux](https://github.com/hybridgroup/robeaux) React.js interface with Gobot by navigating to `http://localhost:3000/index.html`. +## CLI + +Gobot uses the Gort [http://gort.io](http://gort.io) Command Line Interface (CLI) so you can access important features right from the command line. We call it "RobotOps", aka "DevOps For Robotics". You can scan, connect, update device firmware, and more! + +Gobot also has its own CLI to generate new projects, adaptors, and drivers. You can check it out at [https://github.com/hybridgroup/gobot/cli](https://github.com/hybridgroup/gobot/cli). + ## Documentation We're busy adding documentation to our web site at http://gobot.io/ please check there as we continue to work on Gobot diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 000000000..b60a8681e --- /dev/null +++ b/cli/README.md @@ -0,0 +1,41 @@ +# Gobot CLI + +Gobot has its own CLI to generate new platforms, adaptors, and drivers. + +## Building the CLI + +``` +go build -o /path/to/dest/gobot . +``` + +## Running the CLI + +``` +/path/to/dest/gobot help +``` + +Should display help for the Gobot CLI: + +``` +CLI tool for generating new Gobot projects. + + NAME: + gobot - Command Line Utility for generating new Gobot adaptors, drivers, and platforms + + USAGE: + gobot [global options] command [command options] [arguments...] + + VERSION: + 0.12.1 + + COMMANDS: + generate Generate new Gobot adaptors, drivers, and platforms + help, h Shows a list of commands or help for one command + + GLOBAL OPTIONS: + --help, -h show help + --version, -v print the version +``` + +## License +Copyright (c) 2013-2016 The Hybrid Group. Licensed under the Apache 2.0 license. diff --git a/cli/doc.go b/cli/doc.go index e2894d5ed..7286262cf 100644 --- a/cli/doc.go +++ b/cli/doc.go @@ -8,7 +8,7 @@ CLI tool for generating new Gobot projects. gobot [global options] command [command options] [arguments...] VERSION: - 0.1 + 0.12.1 COMMANDS: generate Generate new Gobot adaptors, drivers, and platforms