Quickstart¶
Get started with pv in under a minute.
Installation¶
Install pv globally using uv:
uv tool install plan-view
Or install from PyPI:
pip install plan-view
Create a Plan¶
Initialize a new plan.json:
pv init "My Project"
Output:
Created plan.json for 'My Project'
Add Phases and Tasks¶
Add a phase to organize your work:
pv add-phase "Setup" --desc "Project initialization tasks"
Add tasks to the phase:
pv add-task 0 "Create repository" --agent github-git-expert
pv add-task 0 "Set up CI/CD" --agent github-git-expert
pv add-task 0 "Configure linting"
Track Progress¶
Start working on a task:
pv start 0.1.1
Mark it complete:
pv done 0.1.1
View Your Plan¶
See the current status:
pv current
Output:
My Project v1.0.0
Progress: 33% (1/3 tasks)
Phase 0: Setup (33%)
Project initialization tasks
[0.1.1] Create repository (github-git-expert)
[0.1.2] Set up CI/CD (github-git-expert)
[0.1.3] Configure linting
Next: [0.1.2] Set up CI/CD
Using the Examples¶
The repository includes example plan files. Try them:
# View a simple project plan
pv -f examples/simple.json
# Check the next task
pv -f examples/simple.json next
# View a more complex project
pv -f examples/complex.json current
Next Steps¶
See the CLI Reference for all available commands
Learn about the Plan Schema for the file structure
Use
pv --jsonfor machine-readable output in scripts