| name | aurl |
| description | Turn any API into a CLI command. Register OpenAPI or GraphQL endpoints by name, then explore and invoke them. Built for AI agents to use APIs like tool calls. |
aurl
Turn any API spec into a CLI command. Register APIs by name, explore their endpoints, and make requests.
Commands
aurl add [name] [openapi.json URL or path]
aurl add [name] [spec] --base-url [URL]
aurl add [name] [spec] --header "Key: Value"
aurl add --graphql [name] [endpoint]
aurl list
aurl remove [name]
aurl auth [name]
Using a Registered API
aurl [name] --help
aurl [name] describe METHOD /path
aurl [name] describe [field]
aurl [name] docs
aurl [name] METHOD /path
aurl [name] METHOD /path '{"key":"value"}'
aurl [name] '{ graphql query }'
aurl [name] '{ query }' '{"var":"val"}'
Discovery Workflow
When working with an unfamiliar registered API:
aurl [name] --help โ scan all endpoints grouped by tag
aurl [name] describe METHOD /path โ read full docs for an endpoint before calling it
- Make the request โ enum params are validated before sending, missing required body fields trigger a warning
Notes
- Auth is auto-detected from the spec's
securitySchemes during aurl add
- Query params go inline in the path:
aurl [name] GET '/path?key=value'
- Quote paths with
? to prevent shell globbing
- On 4xx errors, the CLI suggests the expected request body from the spec