`bullpen config init`¶

Last updated: July 13, 2026

Create a new configuration file with default settings

Usage¶

bullpen config init [OPTIONS]

Live Help¶

Create a new configuration file with default settings

Usage: bullpen config init [OPTIONS]

Options:
      --env <ENV>
          [possible values: staging, production]

      --output <OUTPUT>
          Output format for command results

          [possible values: table, json]

      --config <CONFIG>
          Path to a custom config.toml file (overrides $BULLPEN_CONFIG and the default location).

          Explicit --config and BULLPEN_CONFIG paths fail closed: if the file is missing, the CLI exits validation instead of silently loading defaults. Credentials still resolve via BULLPEN_HOME, so set BULLPEN_HOME too when isolating a session.

      --output-format <OUTPUT_FORMAT>
          [possible values: table, json]

      --credential-store <CREDENTIAL_STORE>
          [possible values: auto, file, ephemeral]

      --read-only
          Enable read-only mode: blocks all mutating commands

      --non-interactive
          Suppress interactive prompts; does NOT imply --yes for money-moving commands

          [env: BULLPEN_NON_INTERACTIVE=]

  -h, --help
          Print help (see a summary with '-h')

EXAMPLES:
  # Create a config at a custom path
  bullpen --config /tmp/bullpen-example-config.toml config init

  # Create a staging config
  bullpen --config /tmp/bullpen-example-config.toml config init --env staging

  # Create a config and emit JSON
  bullpen --config /tmp/bullpen-example-config.toml config init --output json

Example Commands¶

bullpen --config /tmp/bullpen-example-config.toml config init
bullpen --config /tmp/bullpen-example-config.toml config init --env staging
bullpen --config /tmp/bullpen-example-config.toml config init --output json

JSON Output¶

Contract: JSON Output Contract.

Successful output is a single JSON document. The shape below is representative for this command family; commands may add fields without breaking the shared contract.

Schema version: 1 when a command emits schema_version; otherwise treat the current command shape as contract version 1.

Top-level Keys¶

key	type	nullable	notes
`status`	string	no	`ok` after the config file is written
`path`	string	no	Resolved config.toml path that was written
`env`	string	no	Environment stored in the generated config

Example¶

bullpen --config /tmp/bullpen-example-config.toml config init --output json

{
  "status": "ok",
  "path": "/tmp/bullpen-example-config.toml",
  "env": "production"
}

Stability¶

Patch releases may add nullable or optional fields. Minor releases may add required fields or increment schema_version. Major releases may remove or rename fields.

bullpen config init¶