Skip to main content

Installation

Install the Bauplan CLI and SDK​

Ensure you are running a supported Python version (>=3.10).

Assuming you are in a Python project directory and want to add Bauplan as a dependency, run:

uv add bauplan

Verify the installation by checking the CLI version:

bauplan version
Note

Want to install Bauplan globally instead?▾

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. This sets the key for your default profile:

bauplan config set api_key <your_api_key>

Verify your configuration:

bauplan config get

Option B: Edit the config file manually​

Bauplan stores its configuration in ~/.bauplan/config.yml. You can create or edit this file directly to set up one or more named profiles:

profiles:
    default:
        api_key: <your_api_key>
    another-profile:
        api_key: <another_api_key>

Each profile can have its own API key. The default profile is used automatically unless you specify a different one via the --profile option in the CLI.

If you are using the Python SDK, see notes on Client authentication.

danger

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