Skip to content
qibdo qibdo
Theme
Book a demo

Overview

The qibdo CLI is the command-line interface for qibdo Cloud. It talks to the same API the SDKs and the console use, so anything you can do through the platform API you can do from a terminal or a script.

The command shape

Section titled “The command shape”

Every command follows one shape:

Terminal window
qibdo <service> <resource> <verb> [flags]

<service> is one of the platform services (compute, taxonomy, network, and the rest), <resource> is the collection you are working with, and <verb> is the action. Listing the workspaces of an organisation reads exactly the way it sounds:

Terminal window
qibdo taxonomy workspaces list

Commands that are still taking shape sit behind a stability prefix: qibdo alpha ... may change or disappear in any release, qibdo beta ... is close to settled, and a command with no prefix is safe to build scripts on. The prefix disappearing is the signal that the shape is stable.

Getting set up

Section titled “Getting set up”

A profile points the CLI at your cluster. There is no default endpoint, because every customer operates their own:

Terminal window
qibdo config profiles create prod --endpoint qibdo.example:443
qibdo config profiles activate prod
qibdo taxonomy workspaces list

What applies everywhere

Section titled “What applies everywhere”

Four contracts hold across the whole surface, and each has a concept page:

  • Profiles and configuration covers where settings come from and the order in which a flag, an environment variable, a profile, and a default win.
  • Output and scripting covers the output formats, the --query projection, and which stream carries what.
  • Operations covers the contract every mutating command follows: wait for the server, or take an operation id with --async.
  • Filtering and pagination covers --filter, --order-by, and how the CLI pages through a collection for you.

Guides

Section titled “Guides”

Task walkthroughs are not duplicated per client. Each guide covers one task and presents it for the console, the CLI, and the REST API side by side, so you can switch client without leaving the page. Adding ?client=cli to a guide’s URL opens it with the CLI tab already selected, and it stays selected as you move between guides:

Every service carries its own guides under Guides, and each one has the same client tabs.

Reference

Section titled “Reference”

The command reference documents every command, flag, and example. It is generated from the CLI’s own help text, so the pages and the binary cannot disagree.