Insomnia CLI

CI-friendly CLI to validate, test, and publish OpenAPI specs automatically
Rating
Your vote:
Visit Website
insomnia.rest
Loading
Info updated on:

Turn your API spec into an enforceable checklist that runs on every commit. Inso, the Insomnia command-line tool, slots into any CI system so teams can treat OpenAPI as code: lint it, validate it, bundle it, and block merges when rules are broken. Start by wiring a single job that fetches your spec, applies shared style and governance policies, and fails fast on invalid schemas or missing examples. Use the same command set locally and in CI so developers see the exact outcomes before pushing—no surprises, no manual QA bottlenecks.

Design and review workflows become predictable. Product or backend engineers can iterate on the spec in branches, run validation locally, and open pull requests with confidence. CI annotates diffs with issues, highlights breaking changes against the last released version, and produces artifacts: a bundled spec, a changelog, and machine-readable reports. Keep team rules in one place (naming, pagination, security schemes, error formats), and apply them uniformly across services. When specs are split across files, Inso resolves and bundles them deterministically to keep PR reviews clean and uniform.

Testing shifts left without extra tools. Convert examples into contract tests, point them at a mock server or staging URL, and run the suite inside CI on every push. Use environments and secrets from your pipeline to hit authenticated endpoints safely. Export JUnit or similar reports so your QA dashboard, PR checks, and chat alerts reflect real coverage and failures. Catch drift early by comparing live responses to your OpenAPI contracts. If a change introduces a breaking response code or removes a required field, the pipeline blocks the release and explains exactly why.

Publishing is a buttonless process. After validation and tests pass, CI can package the spec, stamp a version, and push it to your registry or developer portal. Generate docs snapshots for review, update SDK generators, or trigger downstream jobs that deploy gateway configurations. Role-based approvals live in your source control and CI provider; Inso simply enforces the gates with clear exit codes and artifacts. Every run leaves an audit trail—policy results, test outputs, and versioned bundles—so platform teams can trace who changed what and when, speed up incident response, and roll back with confidence.

Review summary

Features

  • OpenAPI linting and schema validation in CI
  • Shared governance rules (Spectral-compatible)
  • Backward-compatibility checks against previous versions
  • Deterministic bundling for multi-file specifications
  • Contract test execution with environment management
  • JUnit and machine-readable reporting for CI dashboards
  • Mock or staging target support for tests
  • Artifact generation: bundled spec, changelog, docs snapshot
  • PR annotations and status checks
  • Works with GitHub Actions, GitLab CI, Jenkins, CircleCI

How It’s Used

  • Gate pull requests by blocking merges on invalid or noncompliant OpenAPI changes
  • Standardize API style and security rules across microservices with one shared ruleset
  • Run contract tests on staging to detect spec drift before release
  • Bundle multi-file specs for clean PRs and consistent publishing
  • Auto-publish validated specs to a registry or developer portal after merge
  • Export JUnit results so QA dashboards and PR checks show test health
  • Generate docs snapshots for tech writers to review alongside code
  • Produce and store changelogs and versioned artifacts for audits and rollbacks

Plans & Pricing

Free

Free

Free updates forever
API Client
Design APIs
Test APIs
Community Support

Individual

$4.16 per user / month

Includes features of Free plan, plus
Unlimited Devices
E2EE Sync
E2EE Team Sync

Team

$10.00 per user / month

Includes features of Individual plan, plus
E2EE Team Sync
User Management

Comments

User

Your vote: