From 422cec370d84e486549a845e5114df786d8332de Mon Sep 17 00:00:00 2001 From: dave Date: Sat, 28 Mar 2026 14:34:45 +0000 Subject: [PATCH] docs: rewrite quickstart as a step-by-step with wizard flow Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eb3c3cfe..47d04a1e 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,21 @@ A story-driven development server that manages work items, spawns coding agents, ## Getting started with Claude Code -The fastest way to use storkit is from a Claude Code terminal session. +1. Download the storkit binary (or build from source — see below). + +2. From your project directory, scaffold and start the server: ```bash -# Install the binary (or build from source — see below) storkit init --port 3000 ``` -This scaffolds a `.storkit/` directory in your project with the pipeline structure, `project.toml` config, and an `.mcp.json` that lets Claude Code discover storkit's MCP tools automatically. +This creates a `.storkit/` directory with the pipeline structure, `project.toml`, and `.mcp.json`. The `.mcp.json` file lets Claude Code discover storkit's MCP tools automatically. -From there, Claude can create stories, start agents, check status, and manage the full pipeline via MCP tools — no web UI required. +3. Open a Claude Code session in the same project directory. Claude will pick up the MCP tools from `.mcp.json`. + +4. Tell Claude: "help me set up this project with storkit." Claude will walk you through the setup wizard — generating project context, tech stack docs, and test/release scripts. Review each step and confirm or ask to retry. + +Once setup is complete, Claude can create stories, start agents, check status, and manage the full pipeline via MCP tools — no commands to memorize. ## Web UI