Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 2.52 KB

README.md

File metadata and controls

45 lines (32 loc) · 2.52 KB

Flow's documentation

New to Flow? Start with Overview.

Table of contents

Start here

  • Overview: one piece of work from idea to reviewed code, how it carries across sessions, and what Flow adds to Claude Code
  • Walkthroughs: every kind of work walked start to finish, from a whole new project to a dependency bump
  • Install: put Flow on your computer, update it, and take it off
  • New project: set a project up with flow init, and choose where its tickets live
  • Sync between computers: your Flow home, how flow sync carries it to your other computers, and moving uncommitted code

Doing the work

  • Tickets: what a ticket holds, its types and statuses, and how tickets wait on each other
  • Phases: the 4 skills that work on a ticket, which to pick, and what each leaves behind
  • Sessions: what Flow does while a session runs, and how work carries over to the next one
  • Subagents: the helper agents Flow starts, and how it proves what each one changed
  • Safety: what runs without asking, what always asks, and what never runs

Getting better

  • Learning: how a lesson from one session changes the next, and the records Flow keeps of what went wrong
  • Rule checks: the scripts that test each edit against a rule, and the scorecard that counts them

Making it yours

  • Configure: settings and which file wins, skills on and off, overlays, and rules
  • Extend: your own skill, a skill repository, a plugin or an MCP server
  • Claude Code features: what Claude Code already does, and where it surprises people

Reference

  • Commands: every flow command you type, its flags, and what it prints
  • Settings: every key in Flow's settings files, and what Flow adds to Claude Code's
  • Skills: every skill Flow ships, and the skill each open ticket gets
  • Files: every folder and file Flow puts on your computer and in a project