Commands

A focused command surface for everyday API testing.

apifire keeps the workflow compact: initialize, validate, authenticate, and run. This page turns that CLI surface into a clear command reference.

Command

apifire --help

#apifire---help

Top-level entry point with the core command list.

apifire [OPTIONS] <COMMAND>

apifire --help output

A CLI API testing tool similar to Postman but runs in command line

Usage: apifire [OPTIONS] <COMMAND>

Commands:
  init      Initialize a new API test project
  run       Run API tests
  auth      Run authentication only to get token
  validate  Validate configuration files

The command surface stays intentionally small.

This is the best starting point when someone is new to the CLI.

Command

init

#init

Bootstrap a repo-friendly API test project from the terminal.

apifire init -n demo -u https://api.example.com

init output

$ apifire init -n demo -u https://api.example.com
✓ Project initialized successfully!

Next steps:
  1. Edit .apifire/config.yaml with your API base URL
  2. Edit .apifire/auth.yaml with your authentication details
  3. Copy .env.example to .env and fill in your credentials
  4. Add your API requests to .apifire/requests/*.yaml
  5. Run tests: apifire run

Generates the default .apifire working structure.

Pairs project naming with a base URL from day one.

Command

run

#run

Execute the request suite once config and request files are ready.

apifire run --parallel

run output

$ apifire run --parallel

Best fit for the normal feedback loop after editing request YAML.

Parallel mode is a good default when your checks are independent.

Command

auth

#auth

Run the authentication flow by itself and optionally emit only the token.

apifire auth --token-only

auth output

$ apifire auth --token-only

Useful when debugging login behavior separately from the rest of the suite.

token-only mode fits shell scripts and CI glue well.

Command

validate

#validate

Validate configuration files before running the full suite.

apifire validate

validate output

$ apifire validate

Good guardrail before longer runs.

Helps catch mistakes in YAML structure and setup flow.