Setup

Gunshi can be installed in various JavaScript environments. Choose the installation method that matches your project setup.

Install

Stable

npm

npm install --save gunshi

pnpm

pnpm add gunshi

yarn

yarn add gunshi

bun

bun add gunshi

LLM-Assisted Development

Gunshi provides tooling to integrate with AI coding assistants such as Claude Code.

The gunshi package ships a guide for coding agents, AGENTS.md, for the installed version. It has a complete example, the rules that the example does not show, and which guide to read for a task. Your AI agent reads it when your agent instructions point to it.

Agent Skill

The gunshi package also ships an agent skill at skills/gunshi/SKILL.md. Package managers that link agent skills from dependencies, such as pnpm v12, make it available to your AI agent once gunshi is installed and its skills are approved (pnpm approve). The skill has the agent read the guide, and add the instructions of the manual setup to AGENTS.md or CLAUDE.md.

An agent uses a skill only when it decides to, and it may not add the instructions while it works on something else. Check that your agent instructions have them.

Manual Setup

Add the following to your AI agent's instructions (e.g., AGENTS.md or CLAUDE.md):

# Learning more about Gunshi

This repository uses the Gunshi library for its command-line interface.

Before writing any Gunshi code, first read `node_modules/gunshi/AGENTS.md`
**completely**, and follow the links in the file when required.

Guides and API References

The guide for coding agents links to the guides and the API references of @gunshi/docs. To let your AI agent read them in Markdown, install the documentation package as a dev dependency, at the same version as gunshi. Replace <gunshi version> with the version of node_modules/gunshi/package.json:

npm

npm install --save-dev @gunshi/docs@<gunshi version>

pnpm

pnpm add -D @gunshi/docs@<gunshi version>

yarn

yarn add -D @gunshi/docs@<gunshi version>

bun

bun add -D @gunshi/docs@<gunshi version>

This package includes guide content and API references as markdown files in llms.txt format.

Requirements

Gunshi requires:

• JavaScript Runtime:
  • Node.js: v22 or later
  • Bun: v1.1 or later
• ES Modules: "type": "module" in package.json
• TypeScript: Version 5.0 or higher (if using TypeScript)