Skip to main content
The Validio CLI, SDK, and API let you interact with the Validio platform programmatically. This guide covers how to:
  • Install the Validio CLI and SDK.
  • Configure the API key credentials that the CLI and SDK use by default.
  • Confirm that the CLI can reach your Validio instance.

​
Install the Validio CLI and SDK

The Validio CLI and SDK are published as Python packages on PyPI as validio-cli and validio-sdk. You can use a Python package installer, such as pip, to install them in your desired environment. The CLI depends on the SDK, so installing validio-cli installs both:
Bash
To install only the SDK:
Bash

​
Configure default API credentials

All requests to the Validio platform require authorization with an API key. To create one, see Authentication. With an API key, you can configure the CLI and SDK to always use the same endpoint, access key, and access secret. Run validio config init and enter the endpoint URI, API access key, and API access secret. The endpoint URI is the base URL of your Validio instance, the URL you use to access Validio. For example, https://your-validio-instance. Enter it without a path: the CLI and SDK add the /api path themselves.
Bash
The credentials are stored locally on your disk and used whenever you access the Validio platform. Use validio config get to show the current configuration and where the configuration file is located:
Bash
To keep credentials off your disk, set them as environment variables or, with the SDK, pass them directly to the client. See How the CLI and SDK find credentials.

​
Use the Validio CLI

You can now use the Validio CLI to interact with the Validio platform directly from the command line. In this example, the CLI prints a short summary of your credentials:
Bash
For more information and examples, see Validio CLI.