{"id":13581848,"url":"https://github.com/JamesClonk/vultr","last_synced_at":"2025-04-06T10:33:02.690Z","repository":{"id":57479694,"uuid":"30431393","full_name":"JamesClonk/vultr","owner":"JamesClonk","description":" :penguin: Vultr CLI and API client library","archived":false,"fork":false,"pushed_at":"2021-02-25T16:27:50.000Z","size":2996,"stargazers_count":378,"open_issues_count":8,"forks_count":73,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-02T05:44:15.715Z","etag":null,"topics":["cli","go","virtual-machine","vultr","vultr-api","vultr-cli"],"latest_commit_sha":null,"homepage":"https://jamesclonk.github.io/vultr/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JamesClonk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-06T20:23:47.000Z","updated_at":"2025-01-22T19:00:54.000Z","dependencies_parsed_at":"2022-09-26T17:41:29.284Z","dependency_job_id":null,"html_url":"https://github.com/JamesClonk/vultr","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesClonk%2Fvultr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesClonk%2Fvultr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesClonk%2Fvultr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesClonk%2Fvultr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JamesClonk","download_url":"https://codeload.github.com/JamesClonk/vultr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247470536,"owners_count":20944146,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","go","virtual-machine","vultr","vultr-api","vultr-cli"],"created_at":"2024-08-01T15:02:16.445Z","updated_at":"2025-04-06T10:32:59.661Z","avatar_url":"https://github.com/JamesClonk.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# vultr\n[![GoDoc](https://godoc.org/github.com/JamesClonk/vultr/lib?status.png)](https://godoc.org/github.com/JamesClonk/vultr/lib) [![License](https://img.shields.io/github/license/JamesClonk/vultr.svg)](https://en.wikipedia.org/wiki/MIT_License) [![Latest Version](https://img.shields.io/github/release/JamesClonk/vultr.svg)](https://github.com/JamesClonk/vultr/releases) [![Downloads](https://img.shields.io/github/downloads/JamesClonk/vultr/total.svg)](https://github.com/JamesClonk/vultr/releases) [![Build Status](https://travis-ci.org/JamesClonk/vultr.png?branch=master)](https://travis-ci.org/JamesClonk/vultr)\n\n[Vultr](https://www.vultr.com) CLI and API client library, written in [Go](https://golang.org)\n\n### Screenshot\n\n![Screenshot](https://github.com/JamesClonk/vultr/raw/master/screenshot.png \"Screenshot\")\n\nEverybody likes screenshots, even of command line tools.. :smile:\n\n### Installation\n\n* Download the latest release for your OS: https://github.com/JamesClonk/vultr/releases\n* Unzip the file\n* Place the **vultr** binary somewhere into your PATH\n* 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)\n```sh\n$ export VULTR_API_KEY=87dFbC91rJjkL/18zJEQxS\n```\n* Run it\n```sh\n$ vultr version\nClient version:         2.0.3\nVultr API endpoint:     https://api.vultr.com/\nVultr API version:      v1\nOS/Arch (client):       linux/amd64\nGo version:             go1.16\n```\n\n---\n\n### Installation via `brew`\n\n[Homebrew](https://brew.sh/) users can install by:\n\n```sh\n$ brew install vultr\n```\n\n### Installation from source\n\n* Install the latest version of [Go](https://golang.org)\n* Make sure your GOPATH is set\n* Add $GOPATH/bin to your PATH\n* Use \"go get\" to download, compile and install the source\n```sh\n$ go get github.com/JamesClonk/vultr\n```\n* 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)\n```sh\n$ export VULTR_API_KEY=89dFbb91rGjkL/12zJEQxS\n```\n* Run it\n```sh\n$ vultr version\nClient version:         2.0.3\nVultr API endpoint:     https://api.vultr.com/\nVultr API version:      v1\nOS/Arch (client):       linux/amd64\nGo version:             go1.16\n```\n\n---\n\n### Usage\n\nVultr CLI is a command line tool for using the Vultr API.\nIt allows you to create and manage your virtual machines, SSH public keys, snapshots and startup scripts on your Vultr account.\nYou can also use it to directly SSH into a Vultr virtual machine through the *vultr ssh* command.\n\nHere a some usage examples:\n\n---\n\n##### show help text for a command\n```sh\n$ vultr snapshot --help\n```\n```\nUsage: vultr snapshot  COMMAND [arg...]\n\nmodify snapshots\n\nCommands:\n  create       create a snapshot from an existing virtual machine\n  delete       delete a snapshot\n  list         list all snapshots on current account\n\nRun 'vultr snapshot COMMAND --help' for more information on a command\n```\n\n---\n\n##### list available plans for region\n```sh\n$ vultr plans -r 9\n```\n```\nVPSPLANID NAME                                VCPU  RAM   DISK  BANDWIDTH PRICE\n30        1024 MB RAM,20 GB SSD,2.00 TB BW    1     1024  20    2.00      7.00\n29        768 MB RAM,15 GB SSD,1.00 TB BW     1     768   15    1.00      5.00\n3         2048 MB RAM,40 GB SSD,3.00 TB BW    2     2048  40    3.00      15.00\n28        8192 MB RAM,120 GB SSD,5.00 TB BW   4     8192  120   5.00      70.00\n27        4096 MB RAM,65 GB SSD,4.00 TB BW    2     4096  65    4.00      35.00\n```\n\n---\n\n##### add SSH public key\n```sh\n$ vultr sshkey create -n sampleKey --key=\"$(cat ~/.ssh/id_rsa.pub)\"\n```\n```\nSSH key create success!\n\nSSHKEYID        NAME        KEY\n24c81f53be692   sampleKey   ssh-rsa AAAB3NzaC1yc2EQABAQClpsNAM+huOB2dpxM..\n```\n\n---\n\n##### create new virtual machine\n```sh\n$ vultr server create -n \"test-server\" -r 9 -p 29 -o 127\n```\n```\nVirtual machine create success!\n\nSUBID           NAME            DCID    VPSPLANID       OSID\n1685097         test-server     9       29              127\n```\n\n---\n\n##### show information about virtual machine\n```sh\n$ vultr server show 1685097\n```\n```\nId (SUBID):             1685097\nName:                   test-server\nOperating system:       CentOS 6 x64\nStatus:                 active\nPower status:           running\nLocation:               Frankfurt\nRegion (DCID):          9\nVCPU count:             1\nRAM:                    768 MB\nDisk:                   Virtual 15 GB\nAllowed bandwidth:      1000\nCurrent bandwidth:      0\nCost per month:         5.00\nPending charges:        0.01\nPlan (VPSPLANID):       29\nIP:                     107.62.131.240\nNetmask:                255.255.254.0\nGateway:                107.62.131.1\nInternal IP:\n#1 IPv6 IP:\n#1 IPv6 Network:        ::\n#1 IPv6 Network Size:   0\nCreated date:           2015-02-08 12:36:36\nDefault password:       sbiecxo8yk!5\nAuto backups:           no\nKVM URL:                https://my.vultr.com/subs/vps/novnc/api.php?data=ILXS..\n```\n\n---\n\n##### SSH into virtual machine\n```sh\n$ vultr ssh 1685097\n```\n```\nWelcome to Ubuntu 14.04.1 LTS (GNU/Linux 3.13.0-37-generic x86_64)\n\n * Documentation:  https://help.ubuntu.com/\nLast login: Thu Oct 16 21:49:35 2014 from 10.0.2.2\nroot@vultr:~#\n\n```\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJamesClonk%2Fvultr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJamesClonk%2Fvultr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJamesClonk%2Fvultr/lists"}