vultr / Vultr Cli
Programming Languages
Projects that are alternatives of or similar to Vultr Cli
vultr-cli
The Vultr Command Line Interface
vultr-cli is a command line interface for the Vultr API
Usage:
vultr-cli [command]
Available Commands:
account Retrieve information about your account
api-key retrieve information about the current API key
apps Display all available applications
backups display all available backups
bare-metal bare-metal is used to access bare metal server commands
block-storage block storage commands
dns dns is used to access dns commands
firewall firewall is used to access firewall commands
help Help about any command
iso iso is used to access iso commands
load-balancer load balancer commands
network network interacts with network actions
object-storage object storage commands
os grab all available operating systems
plans get information about Vultr plans
regions get regions
reserved-ip reserved-ip lets you interact with reserved-ip
script startup script commands
instance commands to interact with instances on vultr
snapshot snapshot commands
ssh-key ssh-key commands
user user commands
version Display current version of Vultr-cli
Flags:
--config string config file (default is $HOME/.vultr-cli.yaml)
-h, --help help for vultr-cli
-t, --toggle Help message for toggle
Use "vultr-cli [command] --help" for more information about a command.
Installation
There are three ways to install vultr-cli
:
- Download a release from GitHub
- From source
- Package Manager
- Brew
- Snap (Coming soon)
- Chocolatey (Coming soon)
GitHub Release
If you are to visit the vultr-cli
releases page. You can download a compiled version of vultr-cli
for you Linux/MacOS/Windows in 64bit.
Building from source
You will need Go installed on your machine in order to work with the source (and make if you decide to pull the repo down).
go get -u github.com/vultr/vultr-cli
Another way to build from source is to
git clone [email protected]:vultr/vultr-cli.git or git clone https://github.com/vultr/vultr-cli.git
cd vultr-cli
make build_(pass name of os + arch)
The available make build options are
- build_mac
- build_linux_amd64
- build_windows_64
Note that the latter method will install the vultr-cli
executable in builds/vultr-cli_(name of os + arch)
.
Installing via Brew
You will need to tap for formula
brew tap vultr/vultr-cli
Then install the formula
brew install vultr-cli
Using Vultr-cli
Authentication
In order to use vultr-cli
you will need to export your Vultr API KEY
export VULTR_API_KEY=your_api_key
Examples
vultr-cli
can interact with all of your Vultr resources. Here are some basic examples to get you started:
List all available servers
vultr-cli server list
Create a server
vultr-cli server create --region <region-id> --plan <plan-id> --os <os-id> --hostname <hostname>
Create a DNS Domain
vultr-cli dns domain create --domain <domain-name> --ip <ip-address>
Utilizing the config flag
The config flag can be used to specify the vultr-cli.yaml file path when it's outside the default location. If the file has the api-key
defined, the CLI will use the vultr-cli.yaml config, otherwise it will default to reading the environment variable for the api key.
vultr-cli instance list --config /Users/myuser/vultr-cli.yaml
Example vultr-cli.yaml config file
api-key: MYKEY
Contributing
Feel free to send pull requests our way! Please see the contributing guidelines.