CLI
Introduction
Civo CLI is a tool to manage your Civo account from the terminal.
Setting up
Civo CLI is built with Go and distributed as binary files, available for multiple operating systems and downloadable from https://github.com/civo/cli/releases.
Civo API keys
In order to use the command-line tool, you will need to authenticate yourself to the Civo API using a special key. You can find an automatically-generated API key or regenerate a new key at [https://www.civo.com/api](https://www.civo.com/api).
Global Options
Civo CLI has global options that can be used in conjunction with all commands
Docker Usage
Civo's CLI utility can also run within a Docker container, if you prefer to keep your base OS clean.
Instances introduction
An instance is a virtual server running on the Civo cloud platform. They can be of variable size and you can run any number of them up to your quota on your account.
Kubernetes clusters
You can manage Kubernetes clusters on Civo using the Kubernetes subcommands.
Kubernetes Applications
You can install applications from the Applications Marketplace through the command-line interface. The installation depends on whether you are creating a new cluster or adding applications to an existing cluster.
Domains and Domain Records
We host reverse DNS for all instances automatically. If you'd like to manage forward (normal) DNS for your domains, you can do that for free within your account.
Firewalls introduction
You can configure custom firewall rules for your instances using the Firewall component of Civo CLI. These are freely configurable, however customers should be careful to not lock out their own access to their instances.
Networks introduction
Civo allows for true private networking if you want to isolate instances from each other.
Civo quotas
All customers joining Civo will have a default quota applied to their account. The quota has nothing to do with charges or payments, but with the limits on the amount of simultaneous resources you can use.
Instance size
Civo instances come in a variety of sizes depending on your need and budget.
SSH keys introduction
To manage the SSH keys for an account that are used to log in to cloud instances, the Civo CLI tool provides the following commands.
Disk Image
Civo instances are built from a disk image. Currently there centos, debian and ubuntu are supported.In order to create an instance the diskimage ID is needed that can be found by running `civo diskimage ls`
Volumes introduction
Volumes are flexible-size additional storage for instances.
Civo regions
As Civo grows, more regions for your instances will become available. You can run `civo region ls` to list the regions available.