-
Notifications
You must be signed in to change notification settings - Fork 99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs for the golang collins cli #598
Open
michaeljs1990
wants to merge
1
commit into
tumblr:gh-pages
Choose a base branch
from
michaeljs1990:gh-pages-plug-go-cli
base: gh-pages
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,50 @@ | ||
<p class="lead">Simple CLI access to Collins in Golang</p> | ||
<h2>Overview</h2> | ||
|
||
<p><code>collins-go-cli</code> allows you to interact with Collins from the command line. This includes changing attributes, provisioning machines, allocating IPs, maintenance-moding machines, etc. Download it from <a href="https://github.com/michaeljs1990/collins-go-cli/releases">collins-go-cli</a> on Github or if you have golang installed you can <code>go get -u cgit.xrt0x.com/xrt0x/collins-go-cli/cmd/collins</code>. The source can be found at <a href="https://github.com/michaeljs1990/collins-go-cli">github.com/michaeljs1990/collins-go-cli</a>. | ||
|
||
<h2>Installation</h2> | ||
<pre> | ||
$ go get -u cgit.xrt0x.com/xrt0x/collins-go-cli/cmd/collins | ||
</pre> | ||
|
||
<p>or curl any of the prebuilt binaries from the release page selecting for the appropriate OS.</p> | ||
|
||
<pre> | ||
$ curl -L -o collins https://github.com/michaeljs1990/collins-go-cli/releases/download/2.0.0/collins_linux_amd64 | ||
</pre> | ||
|
||
<h2>Setup</h2> | ||
<p>See <a href="#configs">configs</a> to setup configurations.</p> | ||
|
||
<h2>Usage</h2> | ||
<p>Check out <a href="https://github.com/michaeljs1990/collins-go-cli">github.com/michaeljs1990/collins-go-cli</a> for documentation</p> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. update this with the output from a |
||
<pre> | ||
$ collins -h | ||
NAME: | ||
collins - Interface with http://tumblr.github.io/collins/ | ||
|
||
USAGE: | ||
collins [global options] command [command options] [arguments...] | ||
|
||
VERSION: | ||
master (4b825dc642cb6eb9a060e54bf8d69288fbee4904) | ||
|
||
COMMANDS: | ||
query, find Search for assets in Collins | ||
modify, set Add and remove attributes, change statuses, and log to assets | ||
log Display log messages on assets | ||
provision Provision assets | ||
power Control and show power status | ||
ipam, address, ipaddress Allocate and delete IPs, show IP pools | ||
state, status Show and manage states and statuses via State API | ||
datacenter, dc Manage multiple Collins configurations | ||
help, h Shows a list of commands or help for one command | ||
|
||
GLOBAL OPTIONS: | ||
--timeout value Timeout in seconds (0 == forever) (default: 0) | ||
--debug Print some extra info to stderr when running commands | ||
-C value, --config value Use specific Collins config yaml for client | ||
--help, -h show help | ||
--version, -v print the version | ||
</pre> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
porque no
github.com/tumblr/collins-go-cli
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah so the package above it literally a cloned version of your collins-cli ruby gem ported to go with some additional features. I can add docs for the tumblr/go-collins library as well though.