Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redbrickai.com/llms.txt

Use this file to discover all available pages before exploring further.

The RedBrick AI Command Line Interface is a package that allows you to interact with the RedBrick AI application programmatically. We recommend you use the CLI for most regular import & export actions. If you want to write Python scripts to perform these actions, or you are interested in more advanced scripting, please use our Python SDK. This documentation covers high-level guides and use cases. If you are interested in more detailed documentation of the CLI interface, please visit the full CLI reference documentation.

​
Configure Your CLI Credentials

Once you have installed the CLI, you need to configure your credentials. The recommended way to authenticate is through browser-based login. Run the following command to open your browser and complete authentication: 
$ redbrick login
This stores short-lived session credentials locally. If you are currently using API key profiles, the CLI will periodically prompt you to switch to browser login.

​
API Key Profiles

You can also configure credentials using an API key. Note that API keys will be sunset in favor of service accounts in a future release.
The URL should default to https://api.redbrickai.com. If you are using a private/single-tenant deployment of RedBrick AI, this will need to be changed for your deployment - reach out to us for confirmation on what the URL needs to be.
For most scenarios, you will only need a single credentials profile. However, if you want to create multiple profiles (perhaps for different organizations), you can do it in the following way: 
$ redbrick config add
To change your profile: 
$ redbrick config set