What is Inso CLI?

Inso CLI is a command line tool that allows you to use Insomnia features in your terminal and CI/CD environments for automation.

Install Inso CLI

How does Inso CLI work?

When you run a command, Inso CLI will look for Insomnia data in two places:

  • In the .insomnia directory in the working directory. This directory is created automatically when Git sync is set up.
  • In the Insomnia app data directory if Insomnia is installed.

You can use the --workingDir or --src options to specify a different data source. For more information, see the Inso CLI reference.

You can also configure Inso CLI to integrate with external vaults. For more information, see External vaults.

What can Inso CLI do?

Commonly used Inso CLI commands

Run tests on a design document

inso run test "design document name" --env "environment name"

Run a request collection

inso run collection "collection name" --env "environment name"

Validate an API specification

inso lint spec "design document name"

Export an API specification to a file

inso export spec "design document name" --output output.yaml

Run a script defined in the configuration file

inso script script-name --env environment-id
Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!