Installation and setup
On this page
This guide sets up Flow in your AdonisJS app. You will:
- Sign in to the AdonisJS Plus registry
- Install Flow and set it up for your coding agents
- Check that your agent sees the Flow skills
You can let your coding agent do every step with one prompt, or do them by hand. Both end in the same place.
Before you start
Section titled "Before you start"- An AdonisJS 7 app, on Node.js 24 or later.
- A coding agent: Claude Code, Cursor, Codex CLI, GitHub Copilot or OpenCode.
- npm, pnpm, Bun or Yarn. With Yarn, the app must use
nodeLinker: node-modules. Plug'n'Play is not supported yet.
Let your agent set it up
Section titled "Let your agent set it up"Paste this prompt into your coding agent, in the root of your project. It signs you in, installs Flow, and asks before it commits anything.
Set up by hand
Section titled "Set up by hand"Point your project at the registry
Section titled "Point your project at the registry"Flow and the premium packages are published under the
@adonisplusscope, on the AdonisJS Plus registry. This line sends that scope to the registry. It holds no token, so commit it.npm@adonisplus:registry=https://plus.adonisjs.com/registry/pnpm@adonisplus:registry=https://plus.adonisjs.com/registry/yarnnpmScopes: adonisplus: npmRegistryServer: "https://plus.adonisjs.com/registry"bun@adonisplus:registry=https://plus.adonisjs.com/registry/The line goes in
.npmrcat the root of your project. With Yarn, it goes in.yarnrc.yml. In a monorepo, that is the workspace root, not your app's folder.Sign in to the registry
Section titled "Sign in to the registry"The command prints a link. Open it, and approve the sign-in on the page it opens. The token is saved in your user config (
~/.npmrc, or~/.yarnrc.ymlwith Yarn), never in the project.npmnpm login --registry=https://plus.adonisjs.com/registry/ --scope=@adonisplus --auth-type=webpnpmnpm login --registry=https://plus.adonisjs.com/registry/ --scope=@adonisplus --auth-type=webyarnyarn npm login --scope adonisplus --web-loginbunnpm login --registry=https://plus.adonisjs.com/registry/ --scope=@adonisplus --auth-type=webThe sign-in creates a token named after your package manager and your system, for example "npm on macOS". It is listed in Tokens on your dashboard, where you can revoke it.
Install Flow
Section titled "Install Flow"Flow is a command line tool, so it is a dev dependency. Run the command in your app's folder, so that in a monorepo Flow goes into your app and not into the workspace root.
npmnpm i -D @adonisplus/flowpnpmpnpm add -D @adonisplus/flowyarnyarn add -D @adonisplus/flowbunbun add -d @adonisplus/flowSet up Flow for your agents
Section titled "Set up Flow for your agents"Run the installer in your app's folder. It asks which coding agents you use, your stack, and the packages to install docs for. It detects each answer, so the defaults are usually right.
npx @adonisplus/flow installYour answers are saved in
flow.lock. The next run reads them, and asks only about what is new.In a monorepo, add
--workspacethe first time. It also writes a pointer to your app in theCLAUDE.mdorAGENTS.mdat the workspace root, so that an agent started there finds your app. Read Monorepos to learn more.Commit the changes
Section titled "Commit the changes"Commit
.npmrc(or.yarnrc.yml),package.json, the lockfile,flow.lock,.flow/review.ymland the change to your ESLint config. In a monorepo, also commit theCLAUDE.mdorAGENTS.mdat the workspace root.Check that it works
Section titled "Check that it works"Start a new session of your coding agent in your app's folder and type
/flow-. The Flow skills show up in the list. On your dashboard, the Install Flow card shows "Registry token created" and "Flow installed in a project".
What the installer writes
Section titled "What the installer writes"The installer writes these files in your app's folder, also in a monorepo.
.flow/docsdocs for the packages your app uses
.flow/lensesthe lenses of the code review
- .flow/review.ymlthe settings of the code review, commit it
.claude/skillsthe Flow skills, in the folder of each agent
- CLAUDE.mdFlow's section, or AGENTS.md for the other agents
- flow.lockyour answers, commit it
Each run writes the docs, the lenses and the skills again, so do not edit them. In CLAUDE.md and AGENTS.md, only Flow's section is replaced, and the rest of the file stays yours. The installer adds the missing entries to .gitignore and .prettierignore, so the docs and the skills stay out of git. Once .flow/review.yml and your ESLint config exist, the installer leaves them as they are.
To use your own docs, skills or lenses next to Flow's, read Customizing Flow.
Premium packages
Section titled "Premium packages"Once your project points at the registry, Persona and Permissions install like any AdonisJS package.
node ace add @adonisplus/personaRead the docs of Persona and Permissions to set them up.
Removing Flow
Section titled "Removing Flow"The uninstaller removes the skills, the docs and Flow's section of CLAUDE.md and AGENTS.md. It asks which agents to remove Flow from.
npx @adonisplus/flow uninstall