openapi-cli-generator

OpenAPI CLI Generator

Note: this project has been modernized to Go 1.24 and refactored to generate self-contained CLI artifacts.

This project generates powerful, ready-to-use CLIs from OpenAPI 3 specifications. Unlike other generators, the resulting CLI is self-contained: all necessary support code (HTTP, auth, formatting) is bundled directly into your project's internal/ directory, removing any dependency on this generator library.

Features

• Zero-Dependency Artifacts: Bundles all support code in internal/.
• Automatic Documentation: Generates a comprehensive README.md for your new CLI.
• Authentication: API keys and OAuth2 (including Auth0 and PKCE support).
• Modern CLI Primitives: Powered by Cobra and Viper.
• Flexible Input: stdin or CLI shorthand.
• Advanced Filtering: Integrated JMESPath for response projection.
• Pretty Output: Colored output via Chroma and structured logging via zerolog.

Getting Started

1. Install the Generator

$ GOPROXY=direct go install github.com/valknarthing/openapi-cli-generator@latest

2. Create Your CLI Project

# Set up your new project directory
$ mkdir my-api-cli && cd my-api-cli

# Initialize your Go module
$ go mod init my-api-cli

# Initialize the generator structure (bundles internal/ support code)
$ openapi-cli-generator init my-api-cli

# Generate the API commands and README.md
$ openapi-cli-generator generate openapi.yaml

3. Build and Install

# Fetch external dependencies
$ go mod tidy

# Build & install your new CLI
$ go install .

# Start using it!
$ my-api-cli --help

OpenAPI Extensions

Change the behavior of your generated CLI using these extensions:

Customization

Since all support code is now in your internal/ folder, you have full control over the generated CLI. Your main.go is the entrypoint where you can:

• Add custom global flags.
• Register HTTP middleware.
• Add pre-run/post-run logic.

See the generated README.md in your new project for specific details on how to use your new CLI.

Development

This project uses Go 1.24+ features like go:embed for asset management.

# Build the generator locally
$ go build -o openapi-cli-generator main.go

# Run tests
$ ./test.sh

License

MIT - See LICENSE for details.