Skip to content

ernestio/ernest-cli

Repository files navigation

Ernest CLI

Synopsis

Ernest helps you deploy your vcloud infrastructure with a few shell commands.

## Build status

  • Master CircleCI
  • Develop CircleCI

Installation

Master Branch

Follow the instructions here to install the appropriate master branch binary of the cli.

Develop Branch

In order to install the develop branch and have it running, you just need to run the following commands:

$ git clone git@github.com:ernestio/ernest-cli.git
$ cd ernest-cli
$ make
$ make install

Set up

You need to set up your remote ernest instance

$ ernest-cli target "http://my.ernest.io"

Run it

You can get help by running:

$ ernest-cli

And read our documentation about how to use the CLI

Running Tests

make test

Shell Completion

Bash

Get completion shim.

wget https://raw.githubusercontent.com/ernestio/ernest-cli/master/autocomplete/bash_autocomplete -O /etc/bash_completion.d/ernest

Load into shell.

echo 'PROG=ernest-cli source /etc/bash_completion.d/ernest' >> ~/.bashrc
source ~/.bashrc

Zsh

Get completion shim.

wget https://raw.githubusercontent.com/ernestio/ernest-cli/master/autocomplete/zsh_autocomplete -O ~/.ernest_completion

Load into shell.

echo 'PROG=ernest-cli source ~/.ernest_completion' >> ~/.zshrc
source ~/.zshrc

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains patches or features, you must include relevant unit tests.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines.

Copyright and License

Code and documentation copyright since 2015 ernest.io authors.

Code released under the Mozilla Public License Version 2.0.