OVHcloud official CLI

ovhcloud is a single, unified command‑line interface for managing the full range of OVHcloud products and account resources directly from your terminal. Whether you need to automate provisioning, perform quick look‑ups, or integrate OVHcloud operations into CI/CD pipelines, ovhcloud offers fine‑grained commands and consistent output formats (table, JSON, YAML, or custom gval expressions).

Table of Contents

• Installation
• Build
• Usage
  • Login
  • Configuration
  • Generate Shell Completion
  • Examples
• Get the sources
  • Run the tests
• Related links

Installation

1. Download latest release
2. Untar / unzip the archive
3. Add the containing folder to your PATH environment variable
4. Check the CLI documentation

Build

# Build the OVHcloud cli
$ make build

# Cross-compile for other targets in ./dist
$ make release-snapshot

# Optionally, you can compile a WASM binary
$ make wasm

Usage

Checkout the full documentation

Invoke the binary ovhcloud[.exe] or run go run ./cmd/ovhcloud.

$ ovhcloud --help
CLI to manage your OVHcloud services

Usage:
  ovhcloud [command]

Available Commands:
  account                          Manage your account
  alldom                           Retrieve information and manage your AllDom services
  baremetal                        Retrieve information and manage your baremetal services
  cdn-dedicated                    Retrieve information and manage your dedicated CDN services
  cloud                            Manage your projects and services in the Public Cloud universe
  completion                       Generate the autocompletion script for the specified shell
  config                           Manage your CLI configuration
  dedicated-ceph                   Retrieve information and manage your Dedicated Ceph services
  dedicated-cloud                  Retrieve information and manage your DedicatedCloud services
  dedicated-cluster                Retrieve information and manage your DedicatedCluster services
  dedicated-nasha                  Retrieve information and manage your Dedicated NasHA services
  domain-name                      Retrieve information and manage your domain names
  domain-zone                      Retrieve information and manage your domain zones
  email-domain                     Retrieve information and manage your Email Domain services
  email-mxplan                     Retrieve information and manage your Email MXPlan services
  email-pro                        Retrieve information and manage your EmailPro services
  help                             Help about any command
  hosting-private-database         Retrieve information and manage your HostingPrivateDatabase services
  iam                              Manage IAM resources, permissions and policies
  ip                               Retrieve information and manage your Ip services
  iploadbalancing                  Retrieve information and manage your IpLoadbalancing services
  ldp                              Retrieve information and manage your Ldp services
  location                         Retrieve information and manage your Location services
  login                            Login to your OVHcloud account to create API credentials
  nutanix                          Retrieve information and manage your Nutanix services
  okms                             Retrieve information and manage your OKMS services
  overthebox                       Retrieve information and manage your OverTheBox services
  ovhcloudconnect                  Retrieve information and manage your OvhCloudConnect services
  pack-xdsl                        Retrieve information and manage your PackXDSL services
  sms                              Retrieve information and manage your SMS services
  ssl                              Retrieve information and manage your SSL services
  ssl-gateway                      Retrieve information and manage your SSL Gateway services
  storage-netapp                   Retrieve information and manage your Storage NetApp services
  support-tickets                  Retrieve information and manage your support tickets
  telephony                        Retrieve information and manage your Telephony services
  veeamcloudconnect                Retrieve information and manage your VeeamCloudConnect services
  veeamenterprise                  Retrieve information and manage your VeeamEnterprise services
  version                          Get OVHcloud CLI version
  vmwareclouddirector-backup       Retrieve information and manage your VmwareCloudDirectorBackup services
  vmwareclouddirector-organization Retrieve information and manage your VmwareCloudDirector Organizations
  vps                              Retrieve information and manage your VPS services
  vrack                            Retrieve information and manage your vRack services
  vrackservices                    Retrieve information and manage your vRackServices services
  webhosting                       Retrieve information and manage your WebHosting services
  xdsl                             Retrieve information and manage your XDSL services

Flags:
  -d, --debug           Activate debug mode (will log all HTTP requests details)
  -f, --format string   Output value according to given format (expression using gval format)
  -h, --help            help for ovhcloud
  -e, --ignore-errors   Ignore errors in API calls when it is not fatal to the execution
  -i, --interactive     Interactive output
  -j, --json            Output in JSON
  -y, --yaml            Output in YAML

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

Login

# Log in and create API credentials (interactive)
$ ovhcloud login

Check out the authentication page for further information about the authentication means.

Configuration

Default settings can be set using a configuration file named .ovh.conf and located in your ${HOME} directory.

Example of configuration file:

[default]
endpoint = ovh-eu

[ovh-eu]
client_id     = <OAuth 2.0 client ID>
client_secret = <OAuth 2.0 client secret>

[ovh-cli]
default_cloud_project = <public cloud project ID>

Generate Shell Completion

# Bash
eval "$(./ovhcloud completion bash)"
# Zsh
eval "$(./ovhcloud completion zsh)"
# Fish
./ovhcloud completion fish | source
# PowerShell
./ovhcloud completion powershell | Out-String | Invoke-Expression

Add the appropriate line to your shell’s startup file (~/.bashrc, ~/.zshrc, etc.) to enable persistent autocompletion.

Examples

Task	Command
Log in and save credentials	ovhcloud login
List VPS instances (tabular)	ovhcloud vps list
Fetch details of a single VPS in JSON	ovhcloud vps get <service_id> --json
Reinstall a baremetal interactively	ovhcloud baremetal reinstall <id> --editor

Get the sources

$ git clone https://github.com/ovh/ovhcloud-cli.git

You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!

Have a look in CONTRIBUTING.md

Run the tests

$ make test

Related links

• Contribute: https://github.com/ovh/ovhcloud-cli/blob/master/CONTRIBUTING.md
• Report bugs: https://github.com/ovh/ovhcloud-cli/issues
• Get latest version: https://github.com/ovh/ovhcloud-cli/releases/latest