Documentation
Guides and command reference for the yapi CLI
Docs generated from yapi e191d6e
Topics
Assertions
Assertions let you validate HTTP responses — status codes, body content, and headers.
Request Chaining
Chains let you execute multiple requests sequentially, passing data between steps.
Config Reference
Every yapi request file starts with `yapi: v1`. This page lists all available fields.
Environments
Environments let you switch between local, staging, and production configs
JQ Filtering
JQ lets you filter and transform JSON responses inline —
Polling
The `wait_for` block lets you poll an endpoint until conditions are met.
Protocols
yapi supports HTTP, gRPC, GraphQL, and TCP as first-class protocols.
Send
`yapi send` makes quick one-off requests without a config file.
yapi — LLM Skill Guide
yapi is a CLI-first, git-friendly API client. You define requests in YAML files and run them from the terminal. No GUI, no accounts, no state — just files and a binary.
Testing
yapi has a built-in test runner for running assertion-based API tests,
Variables
Variables let you parameterize requests — URLs, headers, bodies, assertions.
Commands
yapi
yapi is a unified API client for HTTP, gRPC, and TCP
yapi about
Show comprehensive yapi developer guide
yapi docs
Browse topic-based documentation
yapi history
Show yapi command history (default: last 10)
yapi import
Import an external collection (Postman) to yapi format
yapi list
List all yapi config files in the current directory or project
yapi lsp
Run the yapi language server over stdio
yapi run
Run a request defined in a yapi config file (reads from stdin if no file specified)
yapi send
Send a quick request without a config file
yapi share
Generate a shareable yapi.run link for a config file
yapi stress
Load test a yapi config file with concurrent requests
yapi test
Run all *.test.yapi, *.test.yapi.yml, *.test.yapi.yaml files in the current directory or specified directory
yapi validate
Validate a yapi config file
yapi version
Print version information
yapi watch
Watch a yapi config file and re-run on changes