ai-ready
v1.0.0-alpha.2
Published
Automatic Claude Code plugin discovery for npm dependencies.
Downloads
129
Maintainers
Readme
ai-ready
Automatic Claude Code plugin discovery for npm dependencies.
Purpose
ai-ready automatically discovers and enables Claude Code plugins bundled within your npm dependencies. When you install a package that includes a Claude Code plugin, ai-ready detects it and configures Claude Code to load it—no manual setup required.
Installation
npm install -g ai-readyQuick Start
- Install a package with a Claude Code plugin
- Run
air syncin your project - Restart Claude Code
- The plugin is now active!
Commands
Plugin Management
air plugins view [path]
Show plugins discovered in the current project (or specified path).
air plugins view
air plugins view /path/to/projectair plugins view --all
Show all plugins configured in Claude Code (not just current project).
air plugins view --allair plugins sync [path]
Discover and enable plugins from dependencies.
air plugins sync
air plugins sync --quiet # For use in hooksair sync (shortcut)
Alias for air plugins sync. Provided for convenience and backward compatibility.
air sync # Same as 'air plugins sync'
air sync --quietAutomate Plugin Loading
Run air sync (or equivalently air plugins sync) to scan your project's dependencies for Claude Code plugins and automatically enable them:
air sync # == air plugins syncThis command:
- Scans
node_modulesfor packages containing.claude-plugin/marketplace.json - Updates
~/.claude/settings.jsonto register discovered plugins - Respects user choices (won't re-enable plugins you've disabled)
Development workflow: After running npm install to add new dependencies, run air sync and restart Claude Code. Any plugins bundled in your new dependencies will be automatically available.
For fully automatic discovery, configure Claude Code to run air sync --quiet on session start via a hook. See the Claude Code hooks documentation for details.
For Library Authors
To bundle Claude Code plugins with your npm package:
- Create
.claude-plugin/marketplace.json:
{
"name": "my-library-marketplace",
"owner": {
"name": "Your Name or Organization"
},
"plugins": [
{
"name": "my-library-helper",
"source": "./plugins/helper",
"version": "1.0.0",
"description": "Helps developers use my-library APIs"
}
]
}Add your plugin code to
.claude-plugin/plugins/helper/(or whereversourcepoints)Optionally add a
plugin.jsonmanifest in each plugin directory:
{
"name": "my-library-helper",
"version": "1.0.0",
"description": "Helps developers use my-library APIs",
"commands": "./commands/",
"agents": ["./agents/helper-agent.md"]
}- Publish your package
Users who install your package will automatically get your plugins enabled via air sync.
Marketplace Schema
The marketplace.json file follows the Claude Code Plugin Marketplace schema:
| Field | Required | Description |
|-------|----------|-------------|
| name | Yes | Marketplace identifier (kebab-case) |
| owner | Yes | Marketplace maintainer info ({name, email?, url?}) |
| plugins | Yes | Array of plugin entries |
| metadata | No | Optional description, version, pluginRoot |
Each plugin entry in the plugins array:
| Field | Required | Description |
|-------|----------|-------------|
| name | Yes | Plugin identifier (kebab-case) |
| source | Yes | Relative path or source object |
| version | No | Plugin version (semver) |
| description | No | Brief plugin description |
| author | No | Plugin author info |
| commands | No | Custom command paths |
| agents | No | Agent definition paths |
| hooks | No | Hook configuration |
| mcpServers | No | MCP server configuration |
How It Works
- Discovery: Scans direct dependencies (from
package.json) for packages with.claude-plugin/marketplace.json - Settings Update: Non-destructively updates
$HOME/.claude/settings.json - Respect User Choice: Never re-enables plugins that users have explicitly disabled
Example Workflow
# Install a package with a Claude Code plugin
npm install @anthropic/sdk-helper
# Sync plugins (discovers and enables the plugin)
air sync
# View enabled plugins
air plugins view
# Restart Claude Code to load the new pluginDevelopment
# Clone the repository
git clone https://github.com/liquid-labs/ai-ready
cd ai-ready
# Install dependencies
npm install
# Run tests
npm test
# Build
npm run buildLicense
Apache-2.0
