Skip to content

Quick Start

This guide will get you from zero to managing your first project in under 5 minutes.

Navigate to your git repository:

Terminal window
cd ~/my-project
progit init

This creates a .project/ directory with:

  • config.toml — Project settings
  • issues/ — Issue tracking database
  • sprints/ — Sprint planning data
  • kanban/ — Board configuration

Start GroGit (the ProGit TUI):

Terminal window
progit tui

Or use the shorthand:

Terminal window
pgit

From the TUI:

  1. Press i to open the Issues panel
  2. Press n to create a new issue
  3. Enter title: “Set up project documentation”
  4. Press Enter to save

Or use the CLI:

Terminal window
progit issue create "Set up project documentation" \
--label=setup \
--priority=high
Terminal window
progit sprint create "Sprint 1" \
--weeks=2 \
--goal="Complete MVP features"

In the TUI:

  1. Press k for Kanban view
  2. Navigate with j/k (down/up)
  3. Press l to move right (To Do → In Progress → Done)
  4. Press h to move left

Work on multiple branches simultaneously:

Terminal window
# Create virtual branches
progit branch virtual feature-auth
progit branch virtual feature-ui
# Switch between them
progit branch switch feature-auth
# Work independently
git commit -m "Add auth middleware"
progit branch switch feature-ui

Ask the AI for help:

Terminal window
# In TUI, press `a` for AI panel
# Or CLI:
progit ai "suggest commit message"
progit ai "explain this error"
progit ai "refactor this function"
CommandDescription
progit tuiLaunch TUI
progit issue listList all issues
progit kanbanOpen kanban view
progit sprint statusCurrent sprint status
progit syncSync with remote forge