/
No results found

Using the CLI

aiqa is the command-line client for the Aiqaramba API. Anything you can do through the API you can do through aiqa, with each resource available as its own command: projects, tests, agents, findings, and so on. The client is self-documenting. Every command carries a --help flag that lists the fields it accepts, the endpoint it calls, the status codes it returns, and an example response. Because that help is complete, a coding agent can read it and use the API without any further documentation.

Install

On macOS, install with Homebrew:

brew install alex-ai-eu/tap/aiqa

Then confirm the install:

aiqa version
More platforms are coming soon. Homebrew on macOS is the only packaged install today. Native installers for Windows and Linux package managers are on the way.

Authenticate

Authenticate in your browser:

aiqa login

The CLI creates a personal API key and stores it in your operating system's user configuration directory. Credentials are stored separately for each host.

On a headless machine, create a key from API keys and save it directly:

aiqa login --api-key "your-api-key"

An explicit --api-key or AIQARAMBA_API_KEY overrides the saved credential. The client talks to https://app.aiqaramba.com by default; internal development hosts can be selected with --base-url or AIQARAMBA_BASE_URL.

Make API requests

Commands follow the pattern aiqa <resource> <command>, and request fields are passed as flags. For example, to list your projects:

aiqa projects list

To run an existing test:

aiqa tests run <test-id>

Or to create a new one:

aiqa tests create --project-id <id> --prompt "Complete the checkout flow."

Each command prints the raw JSON response to standard output, so you can pipe it into jq or another tool. The exit code is 0 on success and 1 on any error, and on an error the response body is written to standard error, which keeps the client safe to use in scripts.