Quick Start
This guide gets you from zero to your first MeowKit-managed task in 5 minutes.
Step 1: Install MeowKit
npx mewkit initThe CLI asks two optional questions: a project description and a Gemini API key. Press Enter to skip both. All other settings (cost tracking, memory, mode) default automatically. Takes ~30 seconds.
After scaffolding completes, run setup and verify:
npx mewkit setup
npx mewkit doctorStep 2: Create your first task
npx mewkit task new --type feature "My first feature"This creates a task file under tasks/plans/ using the feature template. Fill in the acceptance criteria before proceeding.
Step 3: Start a Claude Code session
Open your terminal in the project directory and start Claude Code:
claudeClaude automatically reads CLAUDE.md and loads MeowKit's agents, skills, and rules.
Step 4: Run your first command
Try the simplest workflow — planning a feature:
/mk:plan add user authentication with JWTMeowKit will:
- Route to the planner agent
- Challenge your premises (do you really need JWT?)
- Create a structured plan at
tasks/plans/YYMMDD-auth/plan.md - Ask for your approval (Gate 1)
Step 5: See the full pipeline
Once you approve the plan, try the full cook pipeline:
/mk:cookThis runs the complete workflow: Plan → Test → Build → Review → Ship. Each phase activates the appropriate agent, and you'll see the two hard gates in action.
Step 6: Explore more commands
| Command | What it does |
|---|---|
/mk:fix [bug] | Investigate and fix a bug with root cause analysis |
/mk:review | Run a multi-pass code review with adversarial analysis |
/mk:ship | Full ship pipeline: test → review → commit → PR |
/mk:scout [target] | Parallel codebase exploration |
/mk:retro | Sprint retrospective with trend tracking |
What happened behind the scenes
When you ran /mk:plan, MeowKit:
- Phase 0 (Orient): Read relevant topic files on-demand for past patterns, assigned model tier
- Phase 1 (Plan): Planner agent created a structured plan with product + engineering lens
- Gate 1: Waited for your explicit approval before proceeding
No code was written until you approved. That's MeowKit's discipline.
Next steps
- Cheatsheet — quick reference for all commands
- Workflow Phases — understand Phase 0-6
- Build a Feature — how agents and skills work together
- Fix a Bug — structured debugging guide