Waiting for engine...
Skip to main content

Configuring credentials

Configure your Boomi AI 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:

VariableDescriptionRequired?
BOOMI_USERNAMEYour platform email addressRequired
BOOMI_API_TOKENPlatform API Token (generate in Settings)Required
BOOMI_ACCOUNT_IDYour platform account IDRequired
BOOMI_TARGET_FOLDERTarget folder for new components (Claude can create one for you)Optional
BOOMI_ENVIRONMENT_IDRuntime environment ID for deploy and testOptional
BOOMI_TEST_ATOM_IDAtom/runtime ID in the specified environmentOptional

Additional .env options are available for Shared Web Server configuration and other features. Refer to this sample .env.example file for more details.

On this Page