Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JamesClonk/vultr
:penguin: Vultr CLI and API client library
https://github.com/JamesClonk/vultr
cli go virtual-machine vultr vultr-api vultr-cli
Last synced: 2 months ago
JSON representation
:penguin: Vultr CLI and API client library
- Host: GitHub
- URL: https://github.com/JamesClonk/vultr
- Owner: JamesClonk
- License: mit
- Created: 2015-02-06T20:23:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-25T16:27:50.000Z (over 3 years ago)
- Last Synced: 2024-07-31T21:53:23.260Z (2 months ago)
- Topics: cli, go, virtual-machine, vultr, vultr-api, vultr-cli
- Language: Go
- Homepage: https://jamesclonk.github.io/vultr/
- Size: 2.86 MB
- Stars: 377
- Watchers: 12
- Forks: 77
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - vultr
README
# vultr
[](https://godoc.org/github.com/JamesClonk/vultr/lib) [](https://en.wikipedia.org/wiki/MIT_License) [](https://github.com/JamesClonk/vultr/releases) [](https://github.com/JamesClonk/vultr/releases) [](https://travis-ci.org/JamesClonk/vultr)
[Vultr](https://www.vultr.com) CLI and API client library, written in [Go](https://golang.org)
### Screenshot
Everybody likes screenshots, even of command line tools.. :smile:
### Installation
* Download the latest release for your OS: https://github.com/JamesClonk/vultr/releases
* Unzip the file
* Place the **vultr** binary somewhere into your PATH
* Export your Vultr API key into a VULTR_API_KEY env variable. You can get the API key from the [admin panel](https://my.vultr.com/settings)
```sh
$ export VULTR_API_KEY=87dFbC91rJjkL/18zJEQxS
```
* Run it
```sh
$ vultr version
Client version: 2.0.3
Vultr API endpoint: https://api.vultr.com/
Vultr API version: v1
OS/Arch (client): linux/amd64
Go version: go1.16
```
---
### Installation via `brew`
[Homebrew](https://brew.sh/) users can install by:
```sh
$ brew install vultr
```
### Installation from source
* Install the latest version of [Go](https://golang.org)
* Make sure your GOPATH is set
* Add $GOPATH/bin to your PATH
* Use "go get" to download, compile and install the source
```sh
$ go get github.com/JamesClonk/vultr
```
* Export your Vultr API key into a VULTR_API_KEY env variable. You can get the API key from the [admin panel](https://my.vultr.com/settings)
```sh
$ export VULTR_API_KEY=89dFbb91rGjkL/12zJEQxS
```
* Run it
```sh
$ vultr version
Client version: 2.0.3
Vultr API endpoint: https://api.vultr.com/
Vultr API version: v1
OS/Arch (client): linux/amd64
Go version: go1.16
```
---
### Usage
Vultr CLI is a command line tool for using the Vultr API.
It allows you to create and manage your virtual machines, SSH public keys, snapshots and startup scripts on your Vultr account.
You can also use it to directly SSH into a Vultr virtual machine through the *vultr ssh* command.
Here a some usage examples:
---
##### show help text for a command
```sh
$ vultr snapshot --help
```
```
Usage: vultr snapshot COMMAND [arg...]
modify snapshots
Commands:
create create a snapshot from an existing virtual machine
delete delete a snapshot
list list all snapshots on current account
Run 'vultr snapshot COMMAND --help' for more information on a command
```
---
##### list available plans for region
```sh
$ vultr plans -r 9
```
```
VPSPLANID NAME VCPU RAM DISK BANDWIDTH PRICE
30 1024 MB RAM,20 GB SSD,2.00 TB BW 1 1024 20 2.00 7.00
29 768 MB RAM,15 GB SSD,1.00 TB BW 1 768 15 1.00 5.00
3 2048 MB RAM,40 GB SSD,3.00 TB BW 2 2048 40 3.00 15.00
28 8192 MB RAM,120 GB SSD,5.00 TB BW 4 8192 120 5.00 70.00
27 4096 MB RAM,65 GB SSD,4.00 TB BW 2 4096 65 4.00 35.00
```
---
##### add SSH public key
```sh
$ vultr sshkey create -n sampleKey --key="$(cat ~/.ssh/id_rsa.pub)"
```
```
SSH key create success!
SSHKEYID NAME KEY
24c81f53be692 sampleKey ssh-rsa AAAB3NzaC1yc2EQABAQClpsNAM+huOB2dpxM..
```
---
##### create new virtual machine
```sh
$ vultr server create -n "test-server" -r 9 -p 29 -o 127
```
```
Virtual machine create success!
SUBID NAME DCID VPSPLANID OSID
1685097 test-server 9 29 127
```
---
##### show information about virtual machine
```sh
$ vultr server show 1685097
```
```
Id (SUBID): 1685097
Name: test-server
Operating system: CentOS 6 x64
Status: active
Power status: running
Location: Frankfurt
Region (DCID): 9
VCPU count: 1
RAM: 768 MB
Disk: Virtual 15 GB
Allowed bandwidth: 1000
Current bandwidth: 0
Cost per month: 5.00
Pending charges: 0.01
Plan (VPSPLANID): 29
IP: 107.62.131.240
Netmask: 255.255.254.0
Gateway: 107.62.131.1
Internal IP:
#1 IPv6 IP:
#1 IPv6 Network: ::
#1 IPv6 Network Size: 0
Created date: 2015-02-08 12:36:36
Default password: sbiecxo8yk!5
Auto backups: no
KVM URL: https://my.vultr.com/subs/vps/novnc/api.php?data=ILXS..
```
---
##### SSH into virtual machine
```sh
$ vultr ssh 1685097
```
```
Welcome to Ubuntu 14.04.1 LTS (GNU/Linux 3.13.0-37-generic x86_64)
* Documentation: https://help.ubuntu.com/
Last login: Thu Oct 16 21:49:35 2014 from 10.0.2.2
root@vultr:~#
```
---