-
Notifications
You must be signed in to change notification settings - Fork 112
feat(insomnia): koh cli landing page #5877
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
juliamrch
wants to merge
7
commits into
main
Choose a base branch
from
iss5832
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a04b1aa
feat(insomnia): koh landing page
juliamrch 222f8a9
feat(insomnia): add landing page at top navigation + card on insomnia…
juliamrch c1110aa
Apply suggestions from code review
juliamrch d09740a
Apply suggestions from code review
juliamrch 3494beb
fix: frontmatter
juliamrch cd254e7
Update app/_landing_pages/koh.yaml
juliamrch 1e81122
Update app/_landing_pages/koh.yaml
juliamrch File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| 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. | ||
|
|
||
|
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 | ||
|
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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.