Skip to main content

Find a project and read its spec

List the projects you can pick up, and read a project's outcomes and requirements before you start.

Written by Jack Meyers

Before you pick up a project, find one that's ready, and read what it asks for. You can do this yourself, or ask your coding agent: "What projects are ready to build in Grove?"

List projects

grove project list

This lists every project you can see, grouped by initiative. Each row shows the project's ID (such as P-003), its short and long names, status, priority, target date, and lead. The project assigned in this worktree is marked [assigned].

Narrow the list with filters:

Filter

Shows

--status ready

Projects that are ready to build. Use a status's name or label, such as ready or "Ready to build".

--initiative <name-or-slug>

Projects in one initiative.

--priority <level>

Projects with a priority, such as high.

--lead <name>

Projects a person leads.

--member <name>

Projects a person is a member of.

--mine

Projects you lead.

--assigned-here

The project assigned in this worktree.

Repeat a filter to match any of its values, such as --status ready --status building. Use different filters together to match all of them.

After the list, Grove shows the command to pick up each project.

The statuses are Unplanned, Planning, Ready to build, Building, and Built. Pick up projects that are Ready to build.

Read a project's spec

grove project view P-003

A project's spec is two documents:

  • The summary: what the work is for, and its outcomes. Each outcome is something a user can do once the project ships.

  • The requirements: the product decisions. They say what the product does and what the user sees.

Grove prints the summary first, then the requirements. To print only one, add --summary or --requirements. Reading a spec doesn't pick up the project, and writes nothing to your computer.

If a document is missing, Grove says why, such as "This project's summary has not been written yet."

For the project's details, such as its lead, members, and dates, run grove project show P-003.

Read the initiative

A project is one piece of a bigger initiative. To understand the whole problem, read the initiative's plan:

grove initiative list
grove initiative view <slug>

grove initiative view prints the initiative's Opportunity and Solution, its Scope with the projects it holds, and its other documents.

Find other files

A project can also have Scratchpad files, such as research notes and mockups.

  • grove file list lists the files Grove holds for your assigned project.

  • grove artifact read <path> prints one of them.

Related articles

Did this answer your question?