blcli

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2020 License: Apache-2.0 Imports: 1 Imported by: 0

README

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

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

  • List all servers on your account:
blcli server list
  • Create a server:
blcli server create --host bitlaunch --name test --region <region-id> --image <image-id> --size <size-id> --password b1Tl4uNCH!
  • Create a new Lightning Network transaction:
blcli transaction create 20 BTC --lightning
  • View your account and balance
blcli account

Documentation

Overview

Copyright 2020 The blcli Authors All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL