crashlabs/huskies
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 26 Wiki Activity

docs: rewrite quickstart as a step-by-step with wizard flow

Browse Source 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
dave
2026-03-28 14:34:45 +00:00
parent 973b7d6f72
commit 422cec370d
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -4
View File
@@ -4,16 +4,21 @@ A story-driven development server that manages work items, spawns coding agents,
## Getting started with Claude Code ## 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 ```bash
# Install the binary (or build from source — see below)
storkit init --port 3000 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 ## Web UI