Skip to content

BitLaunchIO/blcli

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
cmd
 
 
 
 
 
 
 
 
 
 

blcli

blcli is a command-line interface for BitLaunch.io

Usage:
  blcli [command]

Available Commands:
  account        Retrieve account information
  create-options View images, sizes, and options available for a host when creating a new server.
  help           Help about any command
  server         Manage your virtual machines
  sshkey         Manage SSH Keys
  transaction    Manage transactions
  version        blcli version

Flags:
      --config string   config file (default is $HOME/.blcli.yaml)
  -h, --help            help for blcli
      --token string    API authentication token

Use "blcli [command] --help" for more information about a command.

Installing blcli

Downloading a Release

Visit the Releases page for the blcli GitHub project.

You can optionally move the blcli binary to your path. For example:

sudo mv ~/blcli /usr/local/bin

Building from source

git clone https://github.com/bitlaunchio/blcli.git
cd blcli
go get .
go build .

Authentication

To use blcli you'll need an API access token. You can generate one in your BitLaunch account API page. More information is available at the developer hub.

Once you have your token, you can either:

  1. Specify it with each request:
blcli --token TOKEN_HERE ...
  1. Set it as an environment variable:
export BL_API_TOKEN=TOKEN_HERE

Examples

Here are a few examples of using blcli. More help is available with blcli [command] -h and further documentation is available at the developer hub

  • View your account and balance:
blcli account
  • View your account usage:
blcli account usage --period 2020-09
  • View your account history/activity:
blcli account history
  • List all servers on your account:
blcli server list
  • Create a server:
blcli server create --host bitlaunch --name test --region lon1 --image 10002 --size nibble-1024 --password b1Tl4uNCH!
  • Restart a server:
blcli server restart aaaaaaaaaaabbbbbbbbbbbbb
  • Rebuild a server:
blcli server rebuild aaaaaaaaaaabbbbbbbbbbbbb --image 10000 --description "Ubuntu 18.04 LTS"
  • Resize a server:
blcli server resize aaaaaaaaaaabbbbbbbbbbbbb --size nibble-2048
  • Create a new Lightning Network transaction:
blcli transaction create 20 BTC --lightning

About

The official BitLaunch command-line tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages