Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
d2de4c3
fix(service-info): send only the renewal settings the operator asked …
Denis-hamon Aug 18, 2026
d44f8a2
refactor(service-info): register the renewal flags from the command l…
Denis-hamon Aug 19, 2026
8d3527e
feat(account): read an invoice, and say what a machine actually costs
Denis-hamon Aug 20, 2026
c3590d0
test(account): stop using real account identifiers as fixtures
Denis-hamon Aug 20, 2026
400efb0
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
5927fc9
chore: no account data as test fixtures
Denis-hamon Aug 20, 2026
1c853d3
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
80f61b2
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
965cb5d
chore: the sweep took the identifiers and left the passwords
Denis-hamon Aug 20, 2026
0b84052
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
2ceb31c
fix(account): --filter was accepted, documented, and ignored
Denis-hamon Aug 20, 2026
6466e37
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
5ea87a6
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
b7e1496
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
7a4e02c
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
caa8584
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
6181e97
fix(account): --ignore-errors padded the answer with empty invoices
Denis-hamon Aug 21, 2026
936bcf1
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
e6ebab6
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
49fe7e8
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
c220bbc
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
55fd364
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
8c92cd2
chore: bring in the service-info flag registration from #243
Denis-hamon Aug 23, 2026
1a1bda3
fix(dry-run): stop printing the payload twice
Denis-hamon Aug 24, 2026
c421ef4
test: move the dry-run log tests to their own file
Denis-hamon Aug 24, 2026
9cb5143
Merge remote-tracking branch 'origin/feat/baremetal-confirm-reinstall…
Denis-hamon Aug 24, 2026
37e444b
chore(doc): regenerate after bringing in the parent branch
Denis-hamon Aug 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 24 additions & 103 deletions doc/ovhcloud.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,37 @@
# OVHcloud CLI (`ovhcloud`) Documentation
## ovhcloud

---
CLI to manage your OVHcloud services

## Overview
### Options

`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).

---

## Quick Start

```bash
# Display the top‑level help
ovhcloud --help

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

# List your VPS instances as JSON
ohvcloud vps list -o json
```

Check out the [authentication page](authentication.md) for further information about the authentication means.

You can manage multiple OVHcloud accounts using [profiles](profiles.md). Create a profile with `ovhcloud login --profile <name>`, switch between them with `ovhcloud config profile switch <name>`, or use `--profile <name>` on any command.

### Generate Shell Completion

```bash
# Bash
eval "$(./ovhcloud completion bash)"
# Zsh
eval "$(./ovhcloud completion zsh)"
# Fish
./ovhcloud completion fish | source
# PowerShell
./ovhcloud completion powershell | Out-String | Invoke-Expression
-d, --debug Activate debug mode (will log all HTTP requests details)
-h, --help help for ovhcloud
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

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

---

## Global Usage

```text
ovhcloud [command] [flags]
```

### Global Flags

| Flag | Description |
| ------------------ | ---------------------------------------------------- |
| `--debug` | Activate debug mode (logs all HTTP‑request details). |
| `--ignore-errors` | Ignore errors of API calls made when listing items. |
| `--filter <expr>` | Filter lists output with a [gval] expression. |
| `-h`, `--help` | Display help for `ovhcloud` or a specific command. |
| `-o interactive` | Produce interactive (prompt‑based) output. |
| `-o json` | Output data in JSON format. |
| `-o yaml` | Output data in YAML format. |
| `-o <expr>` | Format output with a [gval] expression. |

[gval]: https://github.com/PaesslerAG/gval

#### Filtering examples

- Strict string equality: `--filter 'name=="something"'`
- String regexp comparison: `--filter 'name=~"something"'`
- Number comparison: `--filter 'bootId > 1'`

#### Formatting example

- Extract only one field: `-o 'ip'`
- Extract an object: `-o '{name: ip}'`

---

## Command Reference

Below is the full list of primary sub‑commands available at the time of writing. Each can be explored in depth with `ovhcloud <command> --help`.
### SEE ALSO

* [ovhcloud account](ovhcloud_account.md) - Manage your account
* [ovhcloud alldom](ovhcloud_alldom.md) - Retrieve information and manage your AllDom services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud backup-services](ovhcloud_backup-services.md) - Retrieve information and manage your Veeam Backup services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud browser](ovhcloud_browser.md) - Launch a TUI for the OVHcloud Manager - Public Cloud universe only [EXPERIMENTAL]
* [ovhcloud cdn-dedicated](ovhcloud_cdn-dedicated.md) - Retrieve information and manage your dedicated CDN services
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud completion](ovhcloud_completion.md) - Generate shell completion scripts
* [ovhcloud config](ovhcloud_config.md) - Manage your CLI configuration
* [ovhcloud dedicated-ceph](ovhcloud_dedicated-ceph.md) - Retrieve information and manage your Dedicated Ceph services
* [ovhcloud dedicated-cloud](ovhcloud_dedicated-cloud.md) - Retrieve information and manage your DedicatedCloud services
Expand All @@ -103,6 +49,7 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your LDP (Logs Data Platform) services
* [ovhcloud location](ovhcloud_location.md) - Retrieve information and manage your Location services
* [ovhcloud login](ovhcloud_login.md) - Login to your OVHcloud account to create API credentials
* [ovhcloud logout](ovhcloud_logout.md) - Revoke your API credentials and remove them from the configuration
* [ovhcloud nutanix](ovhcloud_nutanix.md) - Retrieve information and manage your Nutanix services
* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your OKMS (Key Management Services)
* [ovhcloud overthebox](ovhcloud_overthebox.md) - Retrieve information and manage your OverTheBox services
Expand All @@ -114,6 +61,7 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud storage-netapp](ovhcloud_storage-netapp.md) - Retrieve information and manage your Storage NetApp services
* [ovhcloud support-tickets](ovhcloud_support-tickets.md) - Retrieve information and manage your support tickets
* [ovhcloud telephony](ovhcloud_telephony.md) - Retrieve information and manage your Telephony services
* [ovhcloud upgrade](ovhcloud_upgrade.md) - Upgrade OVHcloud CLI to the latest version
* [ovhcloud veeamcloudconnect](ovhcloud_veeamcloudconnect.md) - Retrieve information and manage your VeeamCloudConnect services
* [ovhcloud veeamenterprise](ovhcloud_veeamenterprise.md) - Retrieve information and manage your VeeamEnterprise services
* [ovhcloud version](ovhcloud_version.md) - Get OVHcloud CLI version
Expand All @@ -125,30 +73,3 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud webhosting](ovhcloud_webhosting.md) - Retrieve information and manage your WebHosting services
* [ovhcloud xdsl](ovhcloud_xdsl.md) - Retrieve information and manage your XDSL services

> **Tip**  Use `-o json`, `-o yaml`, or `-o <format>` with a gval expression to integrate `ovhcloud` into scripts and automation pipelines.

---

## 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> -o json` |
| Reinstall a baremetal interactively | `ovhcloud baremetal reinstall <id> --editor` |

---

## Troubleshooting

* **Verbose output** — Use `--debug` to inspect raw API calls and responses.
* **Authentication issues** — Run `ovhcloud login` again to regenerate valid API keys.
* **Rate limits** — OVHcloud APIs impose rate limits; plan retries or exponential backoff in scripts.

---

## Further Reading

* OVHcloud API reference: [https://eu.api.ovh.com/console](https://eu.api.ovh.com/console)
* OVHcloud community guides and tutorials.
3 changes: 3 additions & 0 deletions doc/ovhcloud_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ Manage your account

* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services
* [ovhcloud account api](ovhcloud_account_api.md) - Manage your API credentials
* [ovhcloud account bill](ovhcloud_account_bill.md) - Read your invoices
* [ovhcloud account get](ovhcloud_account_get.md) - Retrieve basic personal information
* [ovhcloud account refund](ovhcloud_account_refund.md) - Read your refunds
* [ovhcloud account ssh-key](ovhcloud_account_ssh-key.md) - Manage your SSH keys
* [ovhcloud account usage](ovhcloud_account_usage.md) - Show what is running against your next invoice

36 changes: 36 additions & 0 deletions doc/ovhcloud_account_bill.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## ovhcloud account bill

Read your invoices

### Options

```
-h, --help help for bill
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud account](ovhcloud_account.md) - Manage your account
* [ovhcloud account bill details](ovhcloud_account_bill_details.md) - List what one invoice charges for
* [ovhcloud account bill get](ovhcloud_account_bill_get.md) - Get one invoice
* [ovhcloud account bill list](ovhcloud_account_bill_list.md) - List your invoices

44 changes: 44 additions & 0 deletions doc/ovhcloud_account_bill_details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## ovhcloud account bill details

List what one invoice charges for

```
ovhcloud account bill details <bill_id> [flags]
```

### Options

```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state=="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for details
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud account bill](ovhcloud_account_bill.md) - Read your invoices

38 changes: 38 additions & 0 deletions doc/ovhcloud_account_bill_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud account bill get

Get one invoice

```
ovhcloud account bill get <bill_id> [flags]
```

### Options

```
-h, --help help for get
--reveal Print the download link and the PDF password instead of their fingerprints
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud account bill](ovhcloud_account_bill.md) - Read your invoices

57 changes: 57 additions & 0 deletions doc/ovhcloud_account_bill_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## ovhcloud account bill list

List your invoices

### Synopsis

List your invoices.

Without --from, the window is the current month. That is a guard, not a
default for comfort: an account can hold thousands of invoices, and each
one listed is one request to detail it.

```
ovhcloud account bill list [flags]
```

### Options

```
--category string Keep only one category of invoice
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state=="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
--from string Start of the window, YYYY-MM-DD or RFC3339 (default: first day of the current month)
-h, --help help for list
--order-id int Keep only what was billed for this order
--reveal Print the download links instead of their fingerprints
--to string End of the window, YYYY-MM-DD or RFC3339
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud account bill](ovhcloud_account_bill.md) - Read your invoices

35 changes: 35 additions & 0 deletions doc/ovhcloud_account_refund.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## ovhcloud account refund

Read your refunds

### Options

```
-h, --help help for refund
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud account](ovhcloud_account.md) - Manage your account
* [ovhcloud account refund get](ovhcloud_account_refund_get.md) - Get one refund
* [ovhcloud account refund list](ovhcloud_account_refund_list.md) - List your refunds

Loading
Loading