oq

Terminal-based OpenAPI Spec viewer. Provides an interactive interface for browsing and inspecting OpenAPI specifications.

Overview

oq is a Go-based CLI tool that renders OpenAPI specifications in a terminal TUI. It supports all OpenAPI 3.* versions (3.0, 3.1, and 3.2) and both JSON and YAML formats. The tool uses the libopenapi library for parsing and validating specs.

Features

• Interactive TUI — Navigate your OpenAPI spec with a terminal-based UI
• Multi-version support — Works with OpenAPI 3.0, 3.1, and 3.2
• Format support — Both JSON and YAML input formats
• Piping support — Pipe OpenAPI specs directly via stdin
• Keyboard-driven navigation — All actions through keyboard shortcuts

Usage

# From a file
oq openapi.yaml
 
# Piped from stdin
cat openapi.yaml | oq
curl https://api.example.com/openapi.json | oq