Skip to Content
Getting Started

Getting Started

This guide walks you through installing AI Kit, running it on your project, and understanding what it generates.

Prerequisites

  • Node.js 18+ — check with node --version
  • A project with package.json — AI Kit reads this to detect your stack
  • Claude Code or Cursor — at least one AI tool installed

Step 1: Run AI Kit

Navigate to your project root and run:

npx @mikulgohil/ai-kit init

No global install needed — npx downloads and runs it directly.

Step 2: Review the Scan

AI Kit scans your project and shows what it detected:

AI Kit — Project Setup
ℹ Scanning: /Users/you/projects/my-app

Detected Stack
ℹ Framework: Next.js 15.1.0 (app router)
ℹ CMS: Sitecore XM Cloud (JSS 22.3.0)
ℹ Styling: tailwind
ℹ TypeScript: Yes
ℹ Monorepo: No
ℹ Package Manager: npm
ℹ Static Site: Yes (isr)
ℹ Design Tokens: 12 colors, 3 fonts (tailwind-config)
ℹ .aiignore: 2 patterns loaded

If something looks wrong, you’ll get clarification prompts (e.g., router type if both app/ and pages/ directories exist).

Step 3: Choose Your Tools

? Which AI tools does this project use?
❯ Both Claude Code & Cursor
  Claude Code only
  Cursor only

Select which AI tools your team uses. AI Kit generates configs for each.

v1.5.0+: Your choices are saved to ai-kit.config.json. Next time you or a teammate runs ai-kit init, the saved profile is shown and can be reused with one keypress — no questions asked.

Step 4: Handle Conflicts

If you already have a CLAUDE.md or .cursorrules:

? Existing AI config files detected. How should we handle conflicts?
❯ Overwrite — replace with fresh generated files
  Skip — keep existing files, only add missing ones

Step 5: Choose Hook Profile

? Which hook profile would you like?
❯ Standard — auto-format + typecheck + console.log warnings
  Minimal — auto-format + git push safety only
  Strict — standard + ESLint + stop-time audit

Hooks run automatically as you code. See Hooks for details on each profile.

Step 6: Review Generated Files

After generation, you’ll see a summary:

Setup Complete
✓ CLAUDE.md generated
✓ .cursorrules generated
✓ 48 skills generated (Claude Code + Cursor)
✓ 48 legacy commands copied (.claude/commands/)
✓ 16 agents generated (.claude/agents/)
✓ 3 context modes generated (.claude/contexts/)
✓ Hooks configured (standard profile)
✓ 6 guides added to ai-kit/guides/
✓ 3 doc scaffolds created in docs/

Files created in your project:

your-project/
├── CLAUDE.md                          # Claude Code rules
├── .cursorrules                       # Cursor rules
├── .cursor/rules/                     # Scoped Cursor rules (.mdc)
│   ├── base.mdc
│   ├── nextjs-app-router.mdc
│   ├── tailwind.mdc
│   └── ...
├── .claude/
│   ├── skills/                        # Auto-discovered skills (Claude Code)
│   │   ├── new-component/SKILL.md
│   │   ├── review/SKILL.md
│   │   └── ...
│   ├── commands/                      # Legacy slash commands (backward compat)
│   │   ├── prompt-help.md
│   │   ├── new-component.md
│   │   └── ...
│   ├── agents/                        # Specialized AI agents
│   │   ├── planner.md
│   │   ├── code-reviewer.md
│   │   ├── security-reviewer.md
│   │   └── ...
│   ├── contexts/                      # Context modes
│   │   ├── dev.md
│   │   ├── review.md
│   │   └── research.md
│   └── settings.local.json            # Automated hooks (gitignored)
├── .cursor/skills/                    # Auto-discovered skills (Cursor)
│   ├── new-component/SKILL.md
│   ├── review/SKILL.md
│   └── ...
├── ai-kit/
│   └── guides/                        # Developer guides
│       ├── getting-started.md
│       ├── prompt-playbook.md
│       ├── hooks-and-agents.md
│       └── ...
├── docs/                              # Doc scaffolds (won't overwrite existing)
│   ├── mistakes-log.md
│   ├── decisions-log.md
│   └── time-log.md
└── ai-kit.config.json                 # AI Kit configuration

Step 7: Start Using AI

Open your project in Claude Code or Cursor. The AI assistant will automatically read the generated config files and follow your project’s conventions.

Try a skill or slash command to verify:

/prompt-help

Or just describe what you want — the AI will auto-apply the right skill:

I'm not sure how to phrase this request, can you help me?

This launches the prompt-help workflow — a great way to verify everything is working.

Next Steps

Last updated on
AI That Improves ItselfCLI Reference