apix

# apix — API Explorer for Agents

`apix` is a CLI tool for importing, browsing, searching, and calling API endpoint documents stored as local markdown vaults.

## Prerequisites & Installation

Before using `apix`, verify if it is installed:

```bash
apix --version
```

If it is not installed, install it using Homebrew (macOS/Linux):

```bash
brew tap apix-sh/tap
brew install apix
```

Or via the curl installer:

```bash
curl -fsSL https://apix.sh/install | sh
```

## Agent Workflow Guidelines

When an API task is requested, follow this general workflow:

1. **Discover**: Find the relevant endpoint route.

   ```bash
   apix search "create pet"
   # Or list available APIs: apix ls
   ```

2. **Inspect**: Check the endpoint parameters and schema concisely to save your context window.

   ```bash
   apix peek petstore/v1/pets/{petId}/GET
   ```

   _Note: Only use `apix show <route>` if you need the full, detailed documentation, as it can be long._

3. **Execute**: Make the HTTP call using the route you found.
   ```bash
   apix call demo/v1/items/{id}/POST -p id=item_123 -d '{"name":"item"}'
   ```

## Core Commands

### Search & Discovery

- **Search across all indexed APIs**: `apix search <query>`
- **List namespaces**: `apix ls`
- **List endpoints in a namespace**: `apix ls <namespace>/<version>` (e.g., `apix ls petstore/v1`)
- **Full-text search within a namespace**: `apix grep <namespace> <query>`

### Inspecting Endpoints

Routes follow the format: `<namespace>/<version>/<path segments>/<METHOD>` (e.g., `petstore/v1/pets/GET`).

- **Peek (Recommended for Agents)**: `apix peek <route>` — Outputs the YAML frontmatter and condensed required input fields.
- **Show**: `apix show <route>` — Outputs the full markdown documentation for the route or type.

### Executing HTTP Calls

`apix call` automatically resolves the URL, method, and auth requirements from the route's markdown frontmatter.

- **Basic call with a literal path segment**:

  ```bash
  apix call demo/v1/i...