Documentation
Plan a change before you build it
Let the agent analyze the problem and write a plan. Read the plan, correct it, then start the work.
Know when to plan
Use Plan mode when a change touches many files, when you are not sure how to do it, or when a mistake is expensive. For a small and clear change, Regular mode is faster.
In Plan mode the agent reads the repository and saves a plan. It does not change your code and it does not open a pull request.
Start a plan session
Open New session, choose the project and select Plan next to Regular. Describe the result that you want and the limits. Then start the session.
Plan a change on the Plans page opens the same form with Plan already selected.
Read the plan
When the agent saves the plan, the session shows Plan ready with the revision number. Select Review plan to open it. A plan has three parts:
- Goal: the result, in a few sentences.
- Acceptance criteria: how to know that the work is correct.
- Implementation steps: the work, in order.
Correct the plan
You have two ways to change a plan:
- In the session, write what must change in the Refine the plan field and select Refine plan. The agent saves a new revision.
- On the plan page, select Edit plan and change the title, the description, the criteria or the steps yourself. Revision history keeps the earlier versions.
Implement the plan
Select Implement plan. A plan that is a draft must be marked ready first, with Mark as ready.
Before you start, choose how to run the work:
- One agent makes one session that does all the steps that remain.
- Parallel agents makes more than one session.
The sessions start when your plan has capacity. Each session is a normal session: it has a conversation, changes, a preview and a pull request.
After the work starts, the steps of the plan are locked. You can continue to edit the title, the description and the acceptance criteria.
Follow the result
The plan page lists its sessions under Implementation history. The Plans page shows the status of each plan, from draft to released, and has a search field and a filter for the project.