Terminal-Native API Exploration & Execution Platform

APIs should be executable.

Connect your API. Discover its operations. Execute them from anywhere.

APiX automatically uses OpenAPI specifications when available and safe probing mechanisms when they aren't.

$ npm install -g @praiseikebuwa/apix-cli

Try APiX Interactive Demo

apix connect https://api.example.com

$ apix connect https://api.example.com

✓ Connected to API (api.example.com)

✓ OpenAPI 3.1 specification detected (84 endpoints)

──────────────────────────────────────────────────────────

USERS

├── GET /users

├── POST /users

├── GET /users/:id

└── DELETE /users/:id

PAYMENTS

├── GET /payments

└── POST /payments

MAJOR FEATURE

The file format for executable APIs.

Instead of locking requests inside desktop GUI databases or pasting untracked cURL commands, APiX introduces .apix — a single version-controlled file format for your API's entire lifecycle.

✓ Git Version-Controlled: Commit api.apix alongside your source code.
✓ Inline Environments: Map local, staging, and production base URLs seamlessly.
✓ Executable Workflows: Chain responses (e.g. auth tokens) into subsequent requests.
✓ Built-in Assertions: Automated contract tests and JSONPath validations.

Explore .apix Workflows

Homely.apix

# Homely API Specification
name: Homely API
environment: development

environments:
  development:
    baseUrl: "http://localhost:4000"
  production:
    baseUrl: "https://api.homely.com"

request:
  name: Create Booking
  method: POST
  path: /bookings
  body:
    serviceId: "{{serviceId}}"
    customerId: "{{customerId}}"
  tests:
    - expect:
        status: 201

UNIFIED PLATFORM

One API project. Everywhere.

Your .apix project file powers your entire development lifecycle across three native surfaces.

SURFACE 1

Terminal CLI

apix connect

Interactive TUI exploration, safe probing, load benchmarking, natural language control, and mock server generation.

SURFACE 2

VS Code Extension

▶ Run Request

Inline CodeLens execution directly inside .apix files. Test requests without leaving your code editor.

SURFACE 3

CI/CD Automation

apix test --ci

Automate API contract verification and response assertion workflows in GitHub Actions and deployment pipelines.

PARADIGM SHIFT

Why APiX?

A modern developer tool built for speed, version control, and terminal-native execution.

Dimension	Traditional API Tools (Postman / Insomnia)	APiX Platform
Primary Surface	GUI-first desktop application	✓ Terminal-first & editor-native
Request Storage	Proprietary cloud or heavy JSON exports	✓ Git-committed `.apix` files
Environments	Separate desktop app configurations	✓ Inline `.apix` environments
Testing Mode	Manual click-based testing	✓ Executable automated workflows
Core Vision	API client application	✓ Unified API development layer

SIMULATED PLAYGROUND

Interactive Product Simulator

Experience the complete APiX execution lifecycle right inside your browser.

Step 1: Connect API

Complete Feature Suite

Built with precision for software engineers, API architects, and DevOps teams.

🔍

OpenAPI & Probing

Detects OpenAPI specs or uses safe network probing to infer REST endpoints, status codes, and payload schemas.

$ apix explain http://localhost:4000

💬

Natural Language Control

Query APIs using plain English. APiX maps your intent to endpoints, URL path variables, and body parameters.

$ apix ask "get active users limit 10"

⚡

Load Benchmarking

Measure throughput (RPS), connection setup time, TTFB, and latency distributions (P50, P95, P99).

$ apix benchmark /users -c 10 -n 200

💻

10-Language Generator

Instantly convert any operation into syntactically valid code snippets for cURL, JS, TS, Python, Go, Rust, Java, C#, and Dart.

$ apix generate python /users

📊

GraphQL Introspection

Introspect GraphQL endpoints, query schema definitions, inspect mutations, and execute inline GraphQL queries.

$ apix graphql http://localhost:4000/graphql

🛠

Local Mock Server

Turn any OpenAPI file or .apix project file into a local mock server with realistic sample data.

$ apix mock api.apix --port 5050

Multi-Language Code Generator

Generate exact HTTP request code for 10 languages instantly.

CLI Command Reference

Complete guide to APiX commands and flags.

Command	Description	Options / Flags
`apix [url]`	Launch interactive TUI explorer against URL or .apix file	`--openapi <file>`, `--insecure`
`apix explain [url]`	Generate complete API analysis report (resources, health, issues)	`--url <url>`
`apix ask "<query>"`	Execute request constructed via natural language AI mapping	`--url <url>`, `--force`
`apix benchmark <endpoint>`	Run high-throughput latency and RPS benchmarking	`-X GET`, `-n 100`, `-c 5`, `--force`
`apix graphql <url>`	Introspect GraphQL schemas and run inline GraphQL queries	`-q "<query>"`
`apix mock <spec>`	Start a local mock server with generated example payloads	`-p 5050`
`apix diff <specA> <specB>`	Compare two OpenAPI specs and highlight breaking changes	`--json`
`apix quality [target]`	Score API documentation, schema, and error response coverage	`--target <url>`