Vibe AI Kit

Vibe AI Kit is an AI toolkit for developers using Cursor, designed to standardise and speed up vibe coding when starting and evolving projects.

• AI Rules: global rules injected into the agent (coding style, architecture, communication)
• AI Skills: domain/workflow specific skills loaded only when needed
• AI Commands: /command macros representing concrete workflows
• CLI: vibe-ai to bootstrap or install the kit into new or existing projects

Packages

• packages/cli: the vibe-ai CLI implementation
• packages/templates: .cursor/ templates and presets for different project types

For the full conceptual spec, see SPEC.md.

---

What the CLI does

• Scaffold a new project with a ready-to-use .cursor/ folder containing:
  • Core rules (rules/vibe.mdc, rules/coding.mdc)
  • Example skills (e.g. spec-writer)
  • Example commands (e.g. /init-feature)
• Install presets into an existing project by copying predefined skills/commands into .cursor/.
• Prepare for future upgrades (vibe-ai upgrade) without overwriting your local customisations.

---

Installing and building

• Requirements: Node.js ≥ 18 and a package manager (the repo is configured for pnpm).

From the repo root:

pnpm install
pnpm build

This will:

• Install dependencies for the root and the CLI package.
• Build the CLI into packages/cli/dist.

During development you can run:

pnpm -C packages/cli dev

to execute the CLI entry using ts-node.

---

Using the CLI locally

From the repo root, you can invoke the CLI via pnpm or npx:

pnpm node packages/cli/dist/index.cjs --help

Or, for a more realistic flow, link it globally:

cd packages/cli
pnpm build
pnpm link --global

Then you can run:

vibe-ai --help

---

Commands and workflows

vibe-ai init

Goal: bootstrap a new project with a .cursor/ setup that encodes your AI rules, skills, and commands.

Usage:

vibe-ai init my-project

Flow:

• Ask for:
  • Project name (or use the CLI argument)
  • Project type: base, backend-node, fullstack, ai-project
  • Skills to enable (e.g. spec-writer, refactor, elasticsearch, prompt-engineering)
• Copy:
  • packages/templates/base/ into the target directory
  • Merge any extra templates under packages/templates/<project-type>/ if they exist
• Append a note about enabled skills to .cursor/README.md.
• Print next-step hints (open in Cursor, read .cursor/README.md, start coding).

How to integrate into your workflow:

• Run vibe-ai init <project> once when starting a new repo.
• Commit the generated .cursor/ folder so the whole team shares the same AI behaviour.
• Extend or override rules/skills/commands inside .cursor/ as your project evolves.

vibe-ai add

Goal: attach additional skills/commands to an existing project.

Usage:

cd existing-project
vibe-ai add elasticsearch

Behaviour:

• Assumes you already have a .cursor/ folder (either created manually or via vibe-ai init).
• Looks for a preset directory under packages/templates/addons/<name>.
• If found, copies its contents into your project’s .cursor/ directory without overwriting existing files.
• If not found, prints a helpful message and reminds you that you can create your own:
  • ./.cursor/skills/<your-skill>/SKILL.md
  • ./.cursor/commands/<your-command>.mdc

How to integrate:

• Create reusable presets under packages/templates/addons/ for your own org/team.
• Publish vibe-ai (or use a private registry), and share the preset names in your team docs.
• Developers can then run vibe-ai add <preset> to attach those presets to any project.

vibe-ai upgrade (future)

Currently a placeholder that prints the intended behaviour:

• Detect which version of Vibe AI Kit the project is using.
• Apply non-destructive migrations to .cursor/:
  • Add new rules/skills/commands.
  • Avoid overwriting locally modified files.

In the future, this allows you to:

• Keep team-wide rules and skills up-to-date.
• Evolve your AI standards without breaking existing projects.

---

How to implement Vibe AI Kit into your own projects

• Greenfield project:
  • Create an empty folder.
  • Run vibe-ai init <name>.
  • Open it in Cursor; the .cursor/ structure and rules will be active immediately.
• Existing project:
  • From the project root, run vibe-ai init . if you want to scaffold .cursor/ into the current directory, or manually copy .cursor/ from a template.
  • Use vibe-ai add <preset> to add domain-specific skills and commands.
• Customisation:
  • Edit ./.cursor/rules/*.mdc to encode your coding standards and architectural principles.
  • Add new skills under ./.cursor/skills/<name>/SKILL.md describing domain knowledge or workflows.
  • Add new commands under ./.cursor/commands/*.mdc to model repeatable flows (e.g. /init-service, /audit-module).