Skip to main content

Installation

Install the Bauplan CLI and SDK​

You can install Bauplan via uv or pip. Ensure you are running a supported Python version (>=3.10):

uv tool install bauplan --upgrade

Verify the installation by checking the CLI version:

bauplan version

Obtain Your API Key​

Sign in to your Bauplan account, navigate to your Settings → API Keys, and generate a new API key. If you do not have an API key yet, you can request one for free.

caution

Your API key is shown only once. Save it immediately in a secure location.

Configure Your API Key​

Set your API key directly in the Bauplan CLI:

bauplan config set api_key <your_api_key>

Verify your configuration:

bauplan config get

Option B: Use with the Python SDK​

You can either explicitly pass in your key:

import bauplan
client = bauplan.Client(api_key="your_api_key")

Or just call bauplan.Client() without arguments and it will automatically pull your key from the BAUPLAN_API_KEY environment variable, or from your config profile if you ran Option A:

import bauplan
client = bauplan.Client()
danger

Never share your API key publicly. Store it securely using environment variables or secrets management tools in your deployment workflows.

Supported Environments and Constraints​

Bauplan officially supports Python 3.10 or higher. We recommend using a virtual environment (such as venv, virtualenv, or conda) for best practices and dependency management.