Quick Start
This guide will get you from zero to managing your first project in under 5 minutes.
Initialize a Project
Section titled “Initialize a Project”Navigate to your git repository:
cd ~/my-projectprogit initThis creates a .project/ directory with:
config.toml— Project settingsissues/— Issue tracking databasesprints/— Sprint planning datakanban/— Board configuration
Launch the TUI
Section titled “Launch the TUI”Start GroGit (the ProGit TUI):
progit tuiOr use the shorthand:
pgitYour First Issue
Section titled “Your First Issue”From the TUI:
- Press
ito open the Issues panel - Press
nto create a new issue - Enter title: “Set up project documentation”
- Press
Enterto save
Or use the CLI:
progit issue create "Set up project documentation" \ --label=setup \ --priority=highCreate a Sprint
Section titled “Create a Sprint”progit sprint create "Sprint 1" \ --weeks=2 \ --goal="Complete MVP features"Use the Kanban Board
Section titled “Use the Kanban Board”In the TUI:
- Press
kfor Kanban view - Navigate with
j/k(down/up) - Press
lto move right (To Do → In Progress → Done) - Press
hto move left
Virtual Branches
Section titled “Virtual Branches”Work on multiple branches simultaneously:
# Create virtual branchesprogit branch virtual feature-authprogit branch virtual feature-ui
# Switch between themprogit branch switch feature-auth
# Work independentlygit commit -m "Add auth middleware"progit branch switch feature-uiAI Agent
Section titled “AI Agent”Ask the AI for help:
# In TUI, press `a` for AI panel# Or CLI:progit ai "suggest commit message"progit ai "explain this error"progit ai "refactor this function"Next Steps
Section titled “Next Steps”Common Commands
Section titled “Common Commands”| Command | Description |
|---|---|
progit tui | Launch TUI |
progit issue list | List all issues |
progit kanban | Open kanban view |
progit sprint status | Current sprint status |
progit sync | Sync with remote forge |