Skip to content

PuvaanRaaj/skillkit

Repository files navigation

skillkit

License: MIT Go

One source of truth for every AI agent.

skillkit is an open-source CLI that lets teams define project AI rules once in .skillkit/ and sync them to native formats like AGENTS.md, CLAUDE.md, .cursorrules, .cursor/rules/*.mdc, and .github/copilot-instructions.md.

Repository: https://github.com/PuvaanRaaj/skillkit

Website / docs site: https://skillset-v1.netlify.app/

Why skillkit?

  • Single source of truth: keep rules in .skillkit/rules/ + optional scoped rules in .skillkit/scoped/.
  • Deterministic outputs: skillkit sync regenerates tool-native files and tracks them in .skillkit/skillkit.lock.
  • CI-friendly drift checks: skillkit sync --check exits 2 when outputs would change.
  • Monorepo-friendly: optional parent/child .skillkit/ layers can be merged when monorepo.inherit: true (default).

Install

Shell script (Linux / macOS — recommended):

curl -fsSL https://raw.githubusercontent.com/PuvaanRaaj/skillkit/main/install.sh | sh

Install a specific version or to a custom directory:

SKILLKIT_VERSION=v0.1.0 SKILLKIT_INSTALL_DIR=~/.local/bin \
  curl -fsSL https://raw.githubusercontent.com/PuvaanRaaj/skillkit/main/install.sh | sh

Go toolchain:

go install github.com/PuvaanRaaj/skillkit@latest

The binary is installed to $(go env GOPATH)/bin (often ~/go/bin). Add it to your PATH or the shell won’t find skillkit:

# zsh — add to ~/.zshrc
export PATH="$(go env GOPATH)/bin:$PATH"

npm wrapper (expects the Go binary installed separately):

npm install skillkit

If the script can’t find a GitHub Release (404 / empty version), it will try the latest git tag, then fall back to go install github.com/PuvaanRaaj/skillkit@latest (Go must be installed). You can always pin a version: SKILLKIT_VERSION=v0.1.0 curl -fsSL … | sh. For API rate limits, set optional GITHUB_TOKEN.

Quick start

skillkit init
skillkit add base
skillkit sync
skillkit status

From a clone of this repo you can use go run . instead of skillkit.

Example rules

See docs/RULES_EXAMPLES.md for sample global and scoped rules (Markdown + frontmatter).

Already have CLAUDE.md or other tool files?

Import them into .skillkit/rules/, then one sync updates every target (Cursor, Copilot, AGENTS.md, …):

skillkit init
skillkit import --from claude    # or: skillkit import --claude
skillkit sync

One-shot (init + import CLAUDE.md + sync):

skillkit init --import --import-claude --sync
# equivalent: --import --import-from claude --sync

To import everything skillkit can detect (CLAUDE.md, .cursorrules, Copilot instructions, AGENTS.md):

skillkit init --import --sync

Dry-run: skillkit import --dry-run or skillkit import --from claude --dry-run.

Commands

  • skillkit init — create .skillkit/ and apply basic detection defaults (--import, --import-from, --import-claude, --sync)
  • skillkit sync — generate enabled targets
  • skillkit status — show per-target drift vs lockfile
  • skillkit diff — preview changes
  • skillkit import — migrate existing tool configs into .skillkit/ (--from, --claude, --merge, --dry-run)
  • skillkit add|remove|list — manage built-in rules packs (add auto-runs sync unless --no-sync)
  • skillkit validate — basic rules validation (including scoped globs)
  • skillkit export <target> — print generated output to stdout
  • skillkit sync --check — CI-friendly check (exits 2 if outputs would change)
  • skillkit watch — watch .skillkit/ and rerun sync
  • skillkit doctor — quick diagnostics for common issues
  • skillkit generate — generate starter rules from repo heuristics
  • skillkit mcp — minimal MCP server over stdio (experimental)

Supported targets (13 total)

Enabled by default Target key Output
claude CLAUDE.md + .claude/rules/
cursor .cursorrules + .cursor/rules/
copilot .github/copilot-instructions.md
agents_md AGENTS.md (Codex CLI compatible)
opt-in gemini GEMINI.md
opt-in windsurf .windsurfrules
opt-in aider CONVENTIONS.md
opt-in goose .goosehints
opt-in jules JULES.md
opt-in continue .continuerules
opt-in amazon_q .amazonq/dev/prompts.md
opt-in kodu kodu.md
opt-in zed .rules

See docs/TARGET_PLUGINS.md for details and how to add your own.

Docs

  • docs/RULES_EXAMPLES.md (example .skillkit rules)
  • docs/RELEASE.md (how to tag and publish a version)
  • docs/SITE_URL.md (Netlify / canonical URL checklist)
  • docs/ARCHITECTURE.md
  • docs/CONTRIBUTING.md
  • docs/GITHUB_RULES.md (branch ruleset notes + GitHub push-restriction limits on personal repos)
  • docs/PACK_AUTHORING.md
  • docs/TARGET_PLUGINS.md
  • docs/STRETCH.md

License

MIT — see LICENSE.

About

CLI: define AI agent rules once in .skillkit/ and sync to AGENTS.md, Cursor, Claude, Copilot, and more.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors