Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.buttons.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
buttons press

Run a button

​
Synopsis

Run a button by name. Executes the action defined by the button, passing arguments as environment variables (BUTTONS_ARG_<NAME>) for code buttons, or as template substitutions for API buttons. Returns structured output in —json mode. Common flags: —arg KEY=VALUE pass an argument (repeatable; validated against the spec) —timeout SECS override the button’s configured timeout for this press —dry-run print what would run without executing —json emit machine-readable output (default when stdout is piped) Examples: 
buttons press deploy --arg env=production
buttons press weather --arg city=Miami --json
buttons press deploy --dry-run
buttons press slow-task --timeout 120

buttons press [name] [flags]

​
Options

      --arg stringArray            argument as key=value
      --dry-run                    show what would execute without running
  -f, --follow                     stream stdout/stderr to stderr as the press runs (final Result still goes to stdout)
  -h, --help                       help for press
      --idempotency-key string     reuse the cached result for this key if present (cross-run dedup)
      --idempotency-ttl duration   how long idempotency entries stay valid (e.g. 1h, 24h) (default 24h0m0s)
      --timeout int                override timeout in seconds

​
Options inherited from parent commands

      --json       output in JSON format
      --no-input   disable all interactive prompts
      --summary    show a read-only plan/snapshot instead of mutating

​
SEE ALSO

  • buttons - Deterministic workflow engine for agents