digio

Description

Digio is a lightweight and robust command-line interface (CLI) built around the digio-api library and is written in NodeJS. Digio is fully compatible with the DigitalOcean API v2.0, supporting all exposed API methods.

For detailed description and requirements of the different command arguments, see the official DigitalOcean API v2.0 documentation at https://developers.digitalocean.com

Installation

npm install digio

Usage

Run digio help to view all the available modules. Run digio help <module> to view all the available commands in a specific module.

API-keys

Ease of access is managed through the config module. To get started, simply add your API-key using the following command:

digio config addkey <name> <key>

When you add a new API-key, it will automatically be selected as primary. To change which key you will be using, list available keys with digio config listkeys and select the appropriate key with digio config usekey <name>

If you wish to remove an API-key, simply use digio config deletekey <name>

All API-keys are stored in a config file called .digio in your environments home directory, be it ~/ or C:\Users\username\ or similar. The location of the config file will be displayed the first time you run digio, and a default config file is created.

Examples

digio domains create example.com 127.0.0.1      // Create a new domain
digio droplets list                             // List all your droplets
digio droplets reboot 123456                    // Reboot droplet with ID 123456
digio extras rate                               // Display current RateLimit

Whitespace in arguments

For arguments that contain whitespace, wrap the argument in quotation marks:

digio keys create my_pubkey "ssh-rsa AbCz123 [e-mail]"  // Create a new ssh key

Optional arguments

Some API arguments are optional, depending on what type of action is performed. An example is the creation of domain records. To exclude an argument, simply type "null" in the proper argument location. Also keep in mind that strings are parsed strictly, meaning that for example an AAAA record cannot be entered in lowercase.

digio domains createrecord example.com A subdomain 127.0.0.1 null null null

Arguments containing multiple values

Some commands also have multiple-valued arguments. For instance the create droplet command. Here, you can create a comma separated list that will be passed along as a single argument. In this command, the <ssh_keys> <backups> <ipv6> and <priv_net> are not required by the API, and can be set to null.

digio droplets create <name> <region> <size> <image> <ssh_keys> <backups> <ipv6> <priv_net>

Here is an example command that will create a droplet named 'droplet.com' on London 1, with a size of 512MB, using an image with ID 123456. Additionally it will inject your public keys with ID 987654 and fingerprint aa:bb:cc:dd:ee into authorized_keys.

The example command also enables IPv6 and Private Networking, but does not enable backups.

digio droplets create droplet.com lon1 512mb 123456 987654,aa:bb:cc:dd:ee null yes yes

Available modules

• actions
• config
• domains
• droplets
• extras
• images
• keys
• regions
• sizes

Release notes

v1.0.6 (2014-11-27)

• Fix: backup and IPv6 activated on droplet create
• Fix: droplet create showing success on error

View past release notes

Licence

The MIT License (MIT)

Copyright (c) 2014 Tri M. Nguyen & Aleksander Skraastad

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.