Types, API and config — Voidhash Docs

CLI commands for generated types, AI agents, raw API calls and the CLI configuration.

These commands keep your app's generated types current, connect AI agents, call any HTTP API operation, and change the CLI's own settings.

Types and agents

Command	What it does	Key flags
`types generate`	Writes `voidhash.gen.d.ts` from the project's products, perks and locations.	`--watch`, `--poll-interval-ms`
`types check`	Fails when the generated types are behind the project.
`mcp install`	Adds the MCP server to the AI agents on this computer.	`--yes`

API

Command	What it does	Key flags
`api list [search…]`	API operations matching all the words.
`api describe <operation>`	An operation's parameters, body, responses and errors.
`api call <operation>`	Calls an operation as you and prints the JSON response.	`--path name=value`, `--query name=value`, `--body`, `--environment production\|test\|all`

Call the API

api calls any operation of the HTTP API as you, for anything the commands don't cover. It reads the list of operations from the server, so it always matches it.

voidhash api list webhook deliveries
voidhash api describe webhooks.create
voidhash api call webhooks.get --path webhookId=<webhook-id>

--path name=value and --query name=value set parameters; repeat --query for a list. --body takes JSON inline or as @file.json. --project fills in the operation's project, and --environment picks the purchases it reads: production (default), test or all.

Configuration

Command	What it does	Key flags
`config`	Shows the CLI settings, the credential in use and links.
`config set <key> <value>`	Sets `api_url`, `web_url` or `default_project`.	`--profile`
`config reset`	Restores the defaults, or clears the active profile. Keeps sign-ins.

Profiles

A profile keeps settings for another server apart, such as a self-hosted instance. Set values under a profile, then pass the same profile to later commands:

voidhash config set api_url https://api.example.com --profile self-hosted
voidhash config set web_url https://voidhash.example.com --profile self-hosted
voidhash login --profile self-hosted

api_url is the API server and web_url the Studio address that open and login use. Settings live in ~/.voidhash, a JSON file that never holds a token. Each profile keeps its own default project and links, and inherits whatever it doesn't set. Profiles on the same server share one sign-in. config shows the current settings and config reset restores the defaults, or clears only the active profile.

Example

voidhash types check
voidhash api call webhooks.list

Next steps

CLI reference: common flags, output and exit codes.
API overview: the HTTP API behind every command.
MCP server: connect an AI agent.