Skip to content

Quick Start

This guide gets you from zero to your first MeowKit-managed task in 5 minutes.

Step 1: Install MeowKit

bash
npx mewkit init

The 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:

bash
npx mewkit setup
npx mewkit doctor

Step 2: Create your first task

bash
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:

bash
claude

Claude 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 JWT

MeowKit will:

  1. Route to the planner agent
  2. Challenge your premises (do you really need JWT?)
  3. Create a structured plan at tasks/plans/YYMMDD-auth/plan.md
  4. Ask for your approval (Gate 1)

Step 5: See the full pipeline

Once you approve the plan, try the full cook pipeline:

/mk:cook

This 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

CommandWhat it does
/mk:fix [bug]Investigate and fix a bug with root cause analysis
/mk:reviewRun a multi-pass code review with adversarial analysis
/mk:shipFull ship pipeline: test → review → commit → PR
/mk:scout [target]Parallel codebase exploration
/mk:retroSprint retrospective with trend tracking

What happened behind the scenes

When you ran /mk:plan, MeowKit:

  1. Phase 0 (Orient): Read relevant topic files on-demand for past patterns, assigned model tier
  2. Phase 1 (Plan): Planner agent created a structured plan with product + engineering lens
  3. Gate 1: Waited for your explicit approval before proceeding

No code was written until you approved. That's MeowKit's discipline.

Next steps

Released under the MIT License.