skill
v1.0.2
Published
CLI for installing skill packages into .codebuddy/skills
Maintainers
Readme
skill
skill is a small CLI for installing remote skill packages into a local CodeBuddy project.
It maps a package specifier such as skills/react-best-practices to a remote package under
https://github.com/vercel-labs/agent-skills/tree/main/ and installs the result into
.codebuddy/skills/.
Features
- Install a skill with a single command
- Write skills into
.codebuddy/skills/<name> - Support single-file, manifest-based, and directory-listing packages
- Replace an existing installation atomically
- Work well in
npx-first workflows
Requirements
- Node.js 18 or newer
Installation
Run directly with npx:
npx skill skills/react-best-practicesOr install globally:
npm install -g skill
skill skills/react-best-practicesQuick Start
npx skill skills/web-design-guidelinesThis downloads:
https://github.com/vercel-labs/agent-skills/tree/main/skills/web-design-guidelinesand installs into:
.codebuddy/skills/web-design-guidelinesTypical CLI output:
Installed skills/web-design-guidelines
Source: https://github.com/vercel-labs/agent-skills/tree/main/skills/web-design-guidelines
Target: .codebuddy/skills/web-design-guidelines
Files: 3Package Resolution
skill currently accepts package specifiers in this form:
skills/<name>For example:
npx skill skills/demo
npx skill skills/react-best-practices
npx skill skills/web-design-guidelinesThe default remote base URL is:
https://github.com/vercel-labs/agent-skills/tree/mainSupported Package Layouts
skill supports three remote layouts.
1. Single-file skill
https://github.com/vercel-labs/agent-skills/tree/main/skills/xxxThe GitHub directory only needs to contain SKILL.md.
2. Manifest-based multi-file skill
index.json or manifest.json can describe the package contents inside a GitHub skill directory:
{
"files": ["SKILL.md", "notes.md", "assets/template.txt"]
}The manifest must include SKILL.md.
3. Browseable directory listing
For GitHub-hosted skills, skill recursively fetches the full directory tree.
This is useful for real multi-file skills such as:
That lets skill download files such as:
SKILL.mdREADME.mdmetadata.json- nested files under folders like
rules/
Environment Variables
SKILL_BASE_URL
Override the remote base URL for another GitHub repository, a private deployment, local development, or testing:
SKILL_BASE_URL=https://github.com/your-org/agent-skills/tree/main npx skill skills/demoDevelopment
pnpm install
pnpm type-check
pnpm test
pnpm build
pnpm formatPublishing
Before publishing:
pnpm type-check
pnpm test
pnpm build
npm publish --dry-runThen publish:
npm publishIf you later switch to a scoped package name, publish with:
npm publish --access public