Quickstart
Create a portable plugin, check compatibility, and inspect its first native artifacts.
Soubi plugins are directories of Markdown, TypeScript, and supporting files. Start with one source tree, then compile the native artifact each selected harness expects.
No harness installation required
You can run check and build without installing Claude Code, Codex,
OpenCode, or any other target. Install a harness only when you want it to load
the generated plugin.
Before you start
Node.js 20+
Your package manager
The initializer supports npm, pnpm, yarn, and Bun.
An empty or existing directory
Create a standalone plugin or add Soubi without replacing existing project files.
From an empty directory to artifacts
Create the plugin
npx soubi@latest init my-plugin
cd my-pluginThe initializer writes a runnable source tree, adds package scripts, installs dependencies, and initializes Git when appropriate.
Inspect the portable source
The initial plugin is deliberately small:
my-plugin/
├── AGENTS.md
├── plugin.config.ts
├── skills/
│ └── review/
│ └── SKILL.md
├── package.json
└── tsconfig.jsonEdit AGENTS.md for always-on behavior. Add capabilities through recognized paths instead of registering them manually.
Check compatibility
npm run check -- --harness claude,codex,opencodecheck scans the complete plugin and reports native support, translations, dropped features, and target failures without writing output.
Build native artifacts
npm run build -- --harness claude,codex,opencodeSuccessful targets are written independently:
.soubi-out/
├── claude/
├── codex/
└── opencode/Review before installing
Open the generated files, then preview an ownership-aware installation:
npx soubi install . --dry-run --harness claude,codex,opencodeRemove --dry-run only after the destination paths and merge plan look correct.