waterrise#
waterrise keeps a project's plans in the project. Every plan, decision,
review, note and report is a typed file in the repository's planning/
folder. waterrise check validates the folder like code. One local service
per user turns the files into pages, and the pages are where questions get
answered and risky steps approved.
It was written for working with a coding agent. The agent writes its questions into the plan, each with the facts, the options and a recommendation, and you answer them in the page whenever you get to it. A step that is hard to undo carries a gate, and the agent may only take it once you have approved that step in the page and it has not changed since.
The pages#
| Page | Read it when |
|---|---|
| Install | You want waterrise on your machine, or want to know where it keeps things. |
| The planning folder | You write plans by hand, or want to know what an agent writes. |
| The pages | You answer decisions, approve steps and comment. |
| Working with an agent | You let an agent plan and work through waterrise. |
| Commands | You want the whole command list. |
waterrise guide prints the full rulebook, written for agents: how to write
each kind of item, the four ways of working, approvals, and the reference
tables generated from waterrise's own types. It is also in the repository as
waterrise/GUIDE.md.
waterrise is free software under the GNU Affero General Public License, version 3 only (AGPL-3.0-only). If you run a changed waterrise for other people over a network, you must offer them its source.