Skip to content

Commit

Permalink
tools: Add some improved docs to Gobot CLI
Browse files Browse the repository at this point in the history
Signed-off-by: deadprogram <[email protected]>
  • Loading branch information
deadprogram committed Oct 8, 2016
1 parent f539684 commit f12e9b1
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
41 changes: 41 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion cli/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f12e9b1

Please sign in to comment.