Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions app/_data/top_navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ platform:
- text: Inso CLI
url: /inso-cli/
icon: /assets/icons/code.svg
- text: Koh CLI
url: /koh/
icon: /assets/icons/ai.svg
- text: Terraform
url: /terraform/
icon: /assets/icons/terraform.svg
Expand Down Expand Up @@ -142,6 +145,9 @@ ai_tools:
- text: Inso CLI
url: /inso-cli/
icon: /assets/icons/code.svg
- text: Koh CLI
url: /koh/
icon: /assets/icons/ai.svg

support:
- text: Community
Expand Down
12 changes: 11 additions & 1 deletion app/_landing_pages/insomnia.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,17 @@ rows:
icon: /assets/icons/terminal.svg
cta:
text: Learn more
url: /inso-cli/
url: /inso-cli/
- blocks:
- type: card
config:
title: Koh CLI
description: Let AI agents like Claude Code work with your Insomnia collections, requests, and specs.
icon: /assets/icons/ai.svg
tech_preview: true
cta:
text: Learn more
url: /koh/

- header:
type: h2
Expand Down
176 changes: 176 additions & 0 deletions app/_landing_pages/koh.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
metadata:
title: Koh CLI, the agent-friendly CLI for Insomnia
content_type: landing_page
description: This page is an introduction to Koh CLI, an agent-friendly command line tool for Insomnia.
tech_preview: true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tech_preview: true
permalink: /insomnia/koh/
tech_preview: true

Unless we anticipate Koh to work with other products outside of Insomnia, I'd move this to the Insomnia landing page directory and update the permalink to this.

breadcrumbs:
- /insomnia/
products:
- insomnia
tags:
- design-apis
- test-apis

rows:
- header:
type: h1
text: "Koh CLI"

- header:
type: h2
text: What is Koh CLI?
columns:
- blocks:
- type: text
config: |
Koh CLI is an agent-friendly interface to Insomnia, allowing tools like Claude Code or Codex to interact directly with collections, requests, OpenAPI specs and other data stored in Insomnia.

Comment thread
juliamrch marked this conversation as resolved.
Koh CLI isn't the same as [Inso CLI](/inso-cli/), see [the FAQ section](#frequently-asked-questions).

Koh CLI only works with Insomnia [Git projects](/insomnia/storage/#git-sync). For the package and detailed usage, see [koh-cli on npm](https://www.npmjs.com/package/koh-cli#detailed-usage).

- header:
type: h2
text: "Install Koh CLI"
columns:
- blocks:
- type: text
config: |
1. Install with npm:
```bash
npm install -g koh-cli
```
1. Check that Koh was properly installed:
```bash
koh --version
```
- header:
columns:
- header:
type: h2
text: "How does Koh CLI work?"
blocks:
- type: text
config: |
Koh provides skills that teach AI agents how to operate on your Insomnia projects. Install the bundled skills into your agent's skills directory with:

```bash
koh skills install [directory] --agent
```

This installs globally the skills into your agents `/skills/` directory. Point Koh at a different base directory by passing it as an argument, and add `--force` to replace previously installed skill files.

Under the hood, Koh operates on a local Insomnia Git project when you enable [Git Sync](/insomnia/storage/#git-sync). Your collections, documents, and requests are stored as `.yaml` files that Koh reads and updates directly, so any changes are reflected in Insomnia without an import or export step.

By default, Koh uses the current working directory as the project. Use the `--project <path>` option to point to a different project directory:

```bash
koh collection list --project /path/to/project
```

To produce structured JSON that AI agents and LLM workflows can parse, add the `--agent` flag to any command:

```bash
koh collection list --agent
```

Koh currently supports Git projects only, so set up [Git Sync](/insomnia/storage/#git-sync) before running Koh commands.

- header:
text: "What can Koh CLI do?"
type: h2
Comment thread
juliamrch marked this conversation as resolved.
columns:
- blocks:
- type: x_with_y
config:
border: true
type: h2
headers:
- Commonly used Koh CLI commands

items:
- text: |
List all collections in the project
action:
type: command
config:
cmd: koh
args:
- collection
- list
- --agent
- text: |
Show a collection's details
action:
type: command
config:
cmd: koh
args:
- collection
- show
- '"collection name"'
- --agent
- text: |
List the requests in a collection
action:
type: command
config:
cmd: koh
args:
- request
- list
- --collection
- '"collection name"'
- --agent

- text: |
Import an OpenAPI spec as a new document
action:
type: command
config:
cmd: koh
args:
- import
- oas
- document
- '"OpenAPI document name"'
- --agent
- text: |
List the operations defined in a document's OpenAPI spec
action:
type: command
config:
cmd: koh
args:
- document
- spec
- operation
- list
- --document
- '"API name"'
- --agent
- header:
type: h2
text: Frequently asked questions
columns:
- blocks:
- type: faqs
config:
- q: What's the difference between Koh CLI and Inso CLI?
a: |
Both are command line tools for Insomnia, but they're built for different use cases:

* **[Inso CLI](/inso-cli/)** is designed for people and CI/CD pipelines. Use it in production to lint OpenAPI specs, run collections and tests, and automate Insomnia workflows in your terminal or continuous integration environment. Inso CLI can read Insomnia data from a Git project or from the local Insomnia app data directory.
* **Koh CLI** is designed for both humans and AI agents, such as Claude Code or Codex. It exposes collections, requests, and OpenAPI specs as structured commands (use the `--agent` flag for JSON output) and installs skills that teach agents how to operate on your projects. Koh CLI is currently in [Tech Preview](/insomnia/release-policy/#release-types) and works only with Insomnia [Git projects](/insomnia/storage/#git-sync).

In short, use the Inso CLI to automate testing and linting yourself, and Koh CLI to let an AI agent work with your Insomnia data.
- header:
type: h2
text: Detailed usage
columns:
- blocks:
- type: related_resources
config:
- text: npm package documentation
type: blog
url: https://www.npmjs.com/package/koh-cli#detailed-usage
Loading