Command Reference

Discovery

`apix search`

Search indexed APIs across sources using the registry.

apix search <query> [--source <name>] [--all-sources] [--no-auto-update]

apix search "payment processing"
apix search stripe --source core

Flag	Description
`--source <name>`	Search within a specific source
`--all-sources`	Search across all configured sources
`--no-auto-update`	Skip automatic registry refresh

`apix update`

Sync local registry metadata from remote sources.

apix update [--source <name>] [--all-sources]

`apix pull`

Sparse-checkout a namespace from a source into the local vault.

apix pull <namespace> [--source <name>]

apix pull openai
apix pull stripe --source core

`apix ls`

List local inventory — namespaces, versions, or detailed routes.

apix ls [namespace|namespace/version[/path...]] [--source <name>]

apix ls
apix ls --source .local

apix ls stripe

apix ls stripe/v1

Shows paths and methods with one-line summaries.

apix ls petstore/v1/pet
apix ls petstore/v1/store/order

Shows only routes under the given path prefix.

`apix show`

Print the full markdown document for a route or type.

apix show <route> [--source <name>]

apix show stripe/v1/charges/POST

`apix peek`

Print frontmatter and required parameters only — minimal context for quick decisions.

apix peek <route> [--source <name>]

apix peek openai/v1/chat/completions/POST

`apix info`

Print API metadata (frontmatter contents from _metadata.md) as a table.

apix info <namespace/version> [--source <name>]

apix info openai/v1

`apix grep`

Full-text search within a namespace's markdown files.

apix grep <namespace> <query> [--limit N] [--source <name>]

apix grep stripe refund --limit 10

Execution

`apix call`

Execute an HTTP request resolved from a route's frontmatter.

apix call <route> [OPTIONS] [--source <name>]

apix call petstore/v1/pets/GET

Path parameters can be inlined:

apix call petstore/v1/pets/pet_123/GET

apix call stripe/v1/charges/POST \
  -p id=ch_123 \
  -q expand=full \
  -H "Authorization: Bearer $KEY" \
  -d '{"amount":2000}'

Flag	Description
`-p key=val`	Path parameter
`-q key=val`	Query parameter
`-H "Header: val"`	HTTP header
`-d '<json>'`	Request body

apix call demo/v1/items/POST -d @payload.json

Or from stdin:

echo '{"name":"item"}' | apix call demo/v1/items/POST -d @-

Management

`apix import`

Generate vault files from an OpenAPI 3.0/3.1 spec (JSON or YAML).

apix import <source> --name <namespace> [--output <vault_root>] [--overwrite]

apix import ./petstore.json --name petstore
apix import https://api.example.com/openapi.json --name example

`apix init`

Create the ~/.apix directory structure and default config.

apix init

`apix source`

Manage third-party sources.

apix source add <name> --remote <url>
apix source remove <name>
apix source list

`apix registry rebuild`

Rebuild the registry index for a source or vault path.

apix registry rebuild [--source <name>] [--path <vault_root>]

`apix completions`

Generate shell completions.

apix completions <bash|zsh|fish|elvish|powershell>

Output Behavior

TTY vs pipe

apix auto-detects the output environment. In a terminal, markdown is rendered with colors and paging. When piped, raw markdown is emitted for machine consumption.

Flag	Description
`--raw`	Force raw markdown in TTY mode
`--no-color`	Disable color output (also `NO_COLOR=1`)
`--no-pager`	Disable automatic paging