Civo CLI

Civo allows you to host DNS for domains registered elsewhere. To use Civo DNS, you must point your domain's nameservers to ns0.civo.com and ns1.civo.com via your registrar.

Domain Management

• Create a domain: civo domain create <domainname>
• List domains: civo domain list
• Delete a domain: civo domain remove <domain_id> (Warning: This immediately removes the domain and all associated DNS records).

DNS Record Management

To create a record, use civo domain record create <domain_id> [options].

Record Creation Options:

• -n, --name <string>: The name of the record.
• -p, --priority <int>: The priority (required for MX records).
• -t, --ttl <int>: The TTL of the record (default: 600).
• -e, --type <string>: The record type (A, CNAME, TXT, SRV, MX).
• -v, --value <string>: The value of the record.

Record Operations:

• List records for a domain: civo domain record list <domain.name>
• Delete a record: civo domain record remove <record_id>

# Create a domain
civo domain create civoclidemo.xyz

# Create an A record
civo domain record create civoclidemo.xyz -n www -t 600 -e A -v 192.168.1.1

# List records
civo domain record list civoclidemo.xyz

# Remove a record
civo domain record remove 4e181dde-bde8-4744-8984-067f957a7d59

If you prefer to keep your base OS clean, you can run the Civo CLI inside a Docker container. To persist your credentials, you must mount your .civo.json file as a volume.

Basic usage with API key persistence:

touch $HOME/.civo.json
docker run -it --rm -v $HOME/.civo.json:/.civo.json civo/cli:latest

Usage with Kubernetes (mounting kubeconfig): To use kubectl (which is included in the image), mount both your .civo.json and your ~/.kube/config.

Recommended Alias (Ubuntu/Debian): Add this to your ~/.bash_profile or ~/.zshrc to use the Docker container as if it were a local binary:

alias civo="docker run -it --rm -v $HOME/.civo.json:/.civo.json civo/cli:latest"

# Basic Docker run
touch $HOME/.civo.json
docker run -it --rm -v $HOME/.civo.json:/.civo.json civo/cli:latest

# Docker run with Kubernetes config
touch $HOME/.civo.json
mkdir $HOME/.kube/
touch $HOME/.kube/config
docker run -it --rm -v $HOME/.civo.json:/.civo.json -v $HOME/.kube/config:/root/.kube/config civo/cli:latest

The Civo CLI supports bash autocompletion. Before enabling Civo's completion, you must ensure bash-completion is installed and sourced in your shell. You can verify bash-completion is working by running type _init_completion.

1. Install and verify bash-completion

Install via your package manager (e.g., apt-get install bash-completion or yum install bash-completion). If type _init_completion fails after installation, add the following to your ~/.bashrc:

source /usr/share/bash-completion/bash_completion

2. Enable Civo completion

You can enable Civo autocompletion using one of two methods:

Method A: Source in ~/.bashrc (Recommended for users)

echo 'source <(civo completion bash)' >> ~/.bashrc

Method B: System-wide via /etc/bash_completion.d

civo completion bash > /etc/bash_completion.d/civo

3. Handle aliases

If you use an alias for civo (e.g., alias c=civo), extend the completion by adding this to your ~/.bashrc:

echo 'alias c=civo' >> ~/.bashrc
echo 'complete -F __start_civo c' >> ~/.bashrc

To use the CLI, you need an API key from https://www.civo.com/api.

Using Environment Variables: You can set the CIVO_TOKEN environment variable. If set, the CLI will use this token instead of the one in the config file. This is ideal for CI/CD pipelines.

Managing Keys via CLI:

1. Add a key: civo apikey add <apikey_name> <apikey>
2. Set default key: civo apikey current <apikey_name> (sets the key for subsequent commands).
3. List keys: civo apikey list
4. Remove a key: civo apikey remove <apikey_name>
5. Show secret key: civo apikey show <apikey_name> (if no name is provided, it shows the default key).

Configuration File: By default, credentials and settings are saved to $HOME/.civo.json. You can change this location by setting the CIVO_CONFIG environment variable.

# Add a new API key
civo apikey add Demo_Test_Key DAb75oyqVeaE7BI6Aa74FaRSP0E2tMZXkDWLC9wNQdcpGfH51r

# Set the default key to use
civo apikey current Demo_Test_Key

# List all stored keys
civo apikey list

# Show the secret for a specific key
civo apikey show my_username

Firewalls allow you to control traffic to and from your instances. By default, all ports are closed for custom firewalls.

Firewall Management

• Create a firewall: civo firewall create <new_firewall_name>
  • Use --no-default-rules to create a firewall without any default rules.
  • Note: --create-rules=false is a deprecated way to achieve the same result.
• List firewalls: civo firewall list
• Delete a firewall: civo firewall remove <firewall_id>

Firewall Rule Management

Rules are added to a firewall using civo firewall rule create <firewall_id> [options].

Rule Creation Options:

• -a, --action <string>: allow or deny (default: allow).
• -c, --cidr <string>: The CIDR range (default: 0.0.0.0/0).
• -d, --direction <string>: ingress or egress (default: ingress).
• -e, --endport <string>: The end port of the rule.
• -l, --label <string>: A display name/reference for the rule.
• -p, --protocol <string>: TCP, UDP, or ICMP (default: TCP).
• -s, --startport <string>: The start port of the rule.

Rule Operations:

• List rules for a firewall: civo firewall rule list <firewall_id> (or civo firewall rule ls <firewall_id>)
• Delete a rule: civo firewall rule remove <firewall_id> <rule_id>

# Create a firewall without default rules
civo firewall create my_secure_firewall --no-default-rules

# Create an ingress rule for SSH
civo firewall rule create <firewall_id> --startport=22 --direction=ingress --label='SSH access' -a allow

# List rules
civo firewall rule list <firewall_id>

# Remove a rule
civo firewall rule remove <firewall_id> <rule_id>