oq - a terminal-based OpenAPI Spec (OAS) viewer

Usage

oq openapi.yaml
# or
cat openapi.yaml | oq
# or
curl https://api.example.com/openapi.json | oq

Press ? to see the help screen with all available keyboard shortcuts.

oq supports both modern major OpenAPI specification versions:

OpenAPI 3.0.x
OpenAPI 3.1.x - by hacky conversion for now until kin-openapi adds 3.1 support

Both JSON and YAML formats are supported.

Using Homebrew (macOS/Linux):

brew install plutov/tap/oq

Or using go install:

go install github.com/plutov/oq@latest

You can also download the compiled binaries from the Releases page.

git clone git@github.com:plutov/oq.git
cd oq
go build -o oq .

MIT License - see LICENSE file for details.

Contributions are welcome! Please feel free to submit issues and pull requests.

When contributing: