Configuring credentials
Updated
Configure your Boomi Companion credentials by setting required and optional environment variables in the .env file of your template workspace.
Prerequisites
- A Boomi Platform account with an API token
- Boomi Companion installed on Claude Code, Claude Cowork, or another supported AI tool
- A template workspace initialized. Refer to Setting up the template workspace for Claude Code and Claude Cowork
Configuring credentials
In your template workspace folder, copy .env.example to .env and populate the following variables:
| Variable | Description | Required? |
|---|---|---|
BOOMI_USERNAME | Your platform email address | Required |
BOOMI_API_TOKEN | Platform API Token (generate in Settings) | Required |
BOOMI_ACCOUNT_ID | Your platform account ID | Required |
BOOMI_TARGET_FOLDER | Target folder for new components (your agent can create one for you) | Optional |
BOOMI_ENVIRONMENT_ID | Runtime environment ID for deploy and test | Optional |
BOOMI_TEST_ATOM_ID | Atom/runtime ID in the specified environment | Optional |
PARTNER_OVERRIDE | Set to true to manage a sub-account from a parent partner account. Must be set together with PARTNER_SUB_ACCOUNT | Optional |
PARTNER_SUB_ACCOUNT | The ID of the sub-account to operate on. You can manage one sub-account at a time. To switch, change this value | Optional |
Managing a partner sub-account
To manage a sub-account, set BOOMI_ACCOUNT_ID to the parent partner account ID, and use an API token generated from that parent account. Then set PARTNER_OVERRIDE=true and PARTNER_SUB_ACCOUNT to the sub-account ID. All platform API calls are routed through the Partner API to the sub-account. You do not need a separate API token for each sub-account.
You can configure Shared Web Server settings and other features with additional .env options. For more information, refer to this sample .env.example file.
Was this topic helpful?
