`bullpen wallet nickname`¶

Last updated: July 13, 2026

Set or clear a nickname for a wallet account

Usage¶

bullpen wallet nickname [OPTIONS] <ADDRESS> [NICKNAME]

Live Help¶

Set or clear a nickname for a wallet account

Usage: bullpen wallet nickname [OPTIONS] <ADDRESS> [NICKNAME]

Arguments:
  <ADDRESS>
          Wallet address to update

  [NICKNAME]
          Nickname to assign. Omit with --clear to remove the nickname

Options:
      --clear
          Clear the existing nickname

      --output <OUTPUT>
          Output format for command results

          [possible values: table, json]

      --env <ENV>
          Target environment to connect to (overrides config.toml)

          [env: BULLPEN_ENV=]
          [possible values: staging, production]

      --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.

      --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:
  # Review wallet addresses before editing labels
  bullpen wallet list

  # Set a wallet nickname; this changes account metadata
  bullpen wallet nickname 0x1111111111111111111111111111111111111111 trading-eoa

  # Clear a wallet nickname; this changes account metadata
  bullpen wallet nickname 0x1111111111111111111111111111111111111111 --clear

  # Export the nickname update as JSON
  bullpen wallet nickname 0x1111111111111111111111111111111111111111 trading-eoa --output json

Example Commands¶

bullpen wallet list
bullpen wallet nickname 0x1111111111111111111111111111111111111111 trading-eoa
bullpen wallet nickname 0x1111111111111111111111111111111111111111 --clear
bullpen wallet nickname 0x1111111111111111111111111111111111111111 trading-eoa --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	`updated` after the nickname update succeeds
`address`	string	no	Wallet address whose nickname was updated
`nickname`	string	yes	New nickname, or null when cleared

Example¶

bullpen wallet nickname 0x1111111111111111111111111111111111111111 trading-eoa --output json

{
  "status": "updated",
  "address": "0x1111111111111111111111111111111111111111",
  "nickname": "trading-eoa"
}

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 wallet nickname¶