Quick start

Set up API checks from a clean repo in minutes.

Use the core apifire flow after installation: inspect the CLI, scaffold a project, fill in auth, validate your files, then run the suite. If apifire is not installed yet, start on the download page first.

Bootstrap a project

$ 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

Install first

Need the CLI on your machine before the first run?

The Download page covers installation paths for macOS, Linux, and Windows before you move into project setup.

Open Download

macOS Homebrew Cask

$ brew install --cask rustx-labs/tap/apifire

Path to first run

A clear path from setup to first run.

Install apifire first

If the CLI is not on your machine yet, start on the download page and choose the installation path for your platform.

$ brew install --cask rustx-labs/tap/apifire

The download page keeps installation separate from onboarding so Quick Start can stay focused on project setup and the first real run.

Inspect the CLI surface

Start with the top-level help output to see the four core subcommands.

$ apifire --help

The core command set is init, run, auth, and validate. The site keeps those commands front and center instead of inventing extra workflows.

Scaffold a project

Generate the default .apifire layout with a name and base URL.

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

This creates .apifire/config.yaml, .apifire/auth.yaml, .apifire/requests/example.yaml, and .env.example so you can start from real files.

Fill in auth and environment

Copy credentials into .env and adjust auth.yaml to match your login endpoint and token path.

$ cp .env.example .env

The generated auth.yaml already shows a bearer token login structure with env interpolation for username and password.

Validate and run

Check configuration first, then execute the suite once the files look right.

$ apifire validate $ apifire run --parallel

validate catches config mistakes before your real run, and run --parallel is the fast path once your requests are ready.

Generated files

The scaffold gives you the files you need from the start.

Instead of handing you an empty project, apifire creates a small, inspectable set of YAML files and an .env example so the initial setup is straightforward.