Skip to content

chore: separate global and command-specific option in help message#270

Open
Cedric / ViaDézo1er (viadezo1er) wants to merge 1 commit into
mainfrom
cedric/sort-help-options
Open

chore: separate global and command-specific option in help message#270
Cedric / ViaDézo1er (viadezo1er) wants to merge 1 commit into
mainfrom
cedric/sort-help-options

Conversation

@viadezo1er

@viadezo1er Cedric / ViaDézo1er (viadezo1er) commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

bt view thread -h outputs:

Before:

Render the LLM conversation thread for a trace

Usage: bt view thread [OPTIONS] [URL]

Arguments:
  [URL]  Braintrust app URL (same as --url)

Options:
      --json
          Output as JSON
      --object-ref <OBJECT_REF>
          Object reference, format: object_type:object_selector (project_logs|experiment|dataset)
      --project-id <PROJECT_ID>
          Project ID to query (overrides -p/--project for project_logs)
  -v, --verbose
          Increase output verbosity [env: BRAINTRUST_VERBOSE=]
  -q, --quiet
          Reduce interactive UI output [env: BRAINTRUST_QUIET=]
      --trace-id <TRACE_ID>
          Root span id for the trace
      --no-color
          Disable ANSI color output [env: BRAINTRUST_NO_COLOR=]
      --url <URL>
          Braintrust app URL to resolve to a trace
      --limit <LIMIT>
          Number of spans to fetch [default: 100]
      --no-input
          Disable all interactive prompts [env: BRAINTRUST_NO_INPUT=]
      --preview-length <PREVIEW_LENGTH>
          Preview length for span rows [default: 125]
      --profile <PROFILE>
          Use a saved login profile (or via BRAINTRUST_PROFILE) [env: BRAINTRUST_PROFILE=]
  -o, --org <ORG_NAME>
          Override active org (or via BRAINTRUST_ORG_NAME) [env: BRAINTRUST_ORG_NAME=]
      --print-queries
          Print each BTQL query and invoke payload before execution
      --non-interactive
          Force non-interactive mode
  -p, --project <PROJECT>
          Override active project [env: BRAINTRUST_DEFAULT_PROJECT]
      --prefer-profile
          Prefer profile credentials even if BRAINTRUST_API_KEY/--api-key is set
      --api-url <API_URL>
          Override API URL (or via BRAINTRUST_API_URL) [env: BRAINTRUST_API_URL]
      --app-url <APP_URL>
          Override app URL (or via BRAINTRUST_APP_URL) [env: BRAINTRUST_APP_URL]
      --ca-cert <CA_CERT>
          Path to a PEM-encoded CA bundle used for HTTPS requests [env: BRAINTRUST_CA_CERT]
      --env-file <ENV_FILE>
          Path to a .env file to load before running commands [env: BRAINTRUST_ENV_FILE]
  -h, --help
          Print help (see more with '--help')

After:

Render the LLM conversation thread for a trace

Usage: bt view thread [OPTIONS] [URL]

Arguments:
  [URL]  Braintrust app URL (same as --url)

Options:
      --object-ref <OBJECT_REF>
          Object reference, format: object_type:object_selector (project_logs|experiment|dataset)
      --project-id <PROJECT_ID>
          Project ID to query (overrides -p/--project for project_logs)
      --trace-id <TRACE_ID>
          Root span id for the trace
      --url <URL>
          Braintrust app URL to resolve to a trace
      --limit <LIMIT>
          Number of spans to fetch [default: 100]
      --preview-length <PREVIEW_LENGTH>
          Preview length for span rows [default: 125]
      --print-queries
          Print each BTQL query and invoke payload before execution
      --non-interactive
          Force non-interactive mode
  -h, --help
          Print help (see more with '--help')

Global options:
      --json                 Output as JSON
  -v, --verbose              Increase output verbosity [env: BRAINTRUST_VERBOSE=]
  -q, --quiet                Reduce interactive UI output [env: BRAINTRUST_QUIET=]
      --no-color             Disable ANSI color output [env: BRAINTRUST_NO_COLOR=]
      --no-input             Disable all interactive prompts [env: BRAINTRUST_NO_INPUT=]
      --profile <PROFILE>    Use a saved login profile (or via BRAINTRUST_PROFILE) [env: BRAINTRUST_PROFILE=]
  -o, --org <ORG_NAME>       Override active org (or via BRAINTRUST_ORG_NAME) [env: BRAINTRUST_ORG_NAME=]
  -p, --project <PROJECT>    Override active project [env: BRAINTRUST_DEFAULT_PROJECT]
      --prefer-profile       Prefer profile credentials even if BRAINTRUST_API_KEY/--api-key is set
      --api-url <API_URL>    Override API URL (or via BRAINTRUST_API_URL) [env: BRAINTRUST_API_URL]
      --app-url <APP_URL>    Override app URL (or via BRAINTRUST_APP_URL) [env: BRAINTRUST_APP_URL]
      --ca-cert <CA_CERT>    Path to a PEM-encoded CA bundle used for HTTPS requests [env: BRAINTRUST_CA_CERT]
      --env-file <ENV_FILE>  Path to a .env file to load before running commands [env: BRAINTRUST_ENV_FILE]

Fix #253

@viadezo1er Cedric / ViaDézo1er (viadezo1er) marked this pull request as ready for review July 13, 2026 22:16
@github-actions

Copy link
Copy Markdown
Contributor

Latest downloadable build artifacts for this PR commit b0d84cac07c0:

Available artifact names
  • artifacts-build-global
  • artifacts-build-local-x86_64-apple-darwin
  • artifacts-build-local-x86_64-pc-windows-msvc
  • artifacts-build-local-aarch64-pc-windows-msvc
  • artifacts-build-local-x86_64-unknown-linux-gnu
  • artifacts-build-local-aarch64-apple-darwin
  • artifacts-build-local-x86_64-unknown-linux-musl
  • artifacts-build-local-aarch64-unknown-linux-gnu
  • artifacts-plan-dist-manifest
  • cargo-dist-cache

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sort options

1 participant