# axx steps

> List, search and inspect the available Gherkin steps

Source: https://axx.nimbusxr.us/next/references/cli/axx-steps/

List every step Axx understands (the packs this project loads).
Agents: search before writing a feature, and never invent step text.

```text
Usage:
  axx steps [flags]
  axx steps [command]

Available Commands:
  explain     Same as `axx explain`: Show which step definition a line matches, or what an error code means
  list        List every step (the same as `axx steps`)
  search      Find steps by intent, e.g. `axx steps search "response status"`
  show        Show one step's documentation, variants and examples

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
  -h, --help                 help for steps
      --pack string          only steps from this pack (e.g. rest, sql, kafka)
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
  -v, --verbose count   increase log verbosity (-v, -vv)

Use "axx steps [command] --help" for more information about a command.
```

## axx steps explain

Explain how Axx reads a step line: the matching definition and captured
arguments, the candidates if it is ambiguous, or the closest steps if it is
undefined. The leading Gherkin keyword is optional.

Given an error code such as AXX-E0102, print what it means and how to fix it.

Exit code 0 means the line matches exactly one step, 3 means it is undefined or
ambiguous.

```text
Usage:
  axx steps explain "<step line>" | AXX-Exxxx [flags]

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
  -h, --help                 help for explain
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
      --pack string     only steps from this pack (e.g. rest, sql, kafka)
  -v, --verbose count   increase log verbosity (-v, -vv)
```

## axx steps list

List every step (the same as `axx steps`)

```text
Usage:
  axx steps list [flags]

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
  -h, --help                 help for list
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
      --pack string     only steps from this pack (e.g. rest, sql, kafka)
  -v, --verbose count   increase log verbosity (-v, -vv)
```

## axx steps search

Find steps by intent, e.g. `axx steps search "response status"`

```text
Usage:
  axx steps search <query> [flags]

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
  -h, --help                 help for search
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
      --pack string     only steps from this pack (e.g. rest, sql, kafka)
  -v, --verbose count   increase log verbosity (-v, -vv)
```

## axx steps show

Show one step: by its id (rest.response.status), its expression as
`axx steps` lists it, or a step line as a feature has it (the leading
keyword is optional), matched the way `axx explain` matches it. Several
ids show each of their steps.

```text
Usage:
  axx steps show <id... | expression | step line> [flags]

Aliases:
  show, inspect

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
  -h, --help                 help for show
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
      --pack string     only steps from this pack (e.g. rest, sql, kafka)
  -v, --verbose count   increase log verbosity (-v, -vv)
```