Skip to content

README.md

Latest commit

 

History

History
157 lines (112 loc) · 4.03 KB

README.md

File metadata and controls

157 lines (112 loc) · 4.03 KB

Command Reference

Detailed documentation for each GitScrum CLI command group.

Command Groups

Core Project Management

Command Description Docs
tasks Task lifecycle — create, assign, track, filter, complete tasks.md
timer Time tracking — start, stop, log, report timer.md
sprints Sprint management — analytics, burndown, KPIs sprints.md
projects Project listing and details projects.md
workspaces Workspace management workspaces.md

Analytics & Reports

Command Description Docs
analytics Sprint and project analytics analytics.md
standup Daily standup reports standup.md

Team Collaboration

Command Description Docs
chat Team chat and discussions chat.md
wiki Project wiki pages wiki.md
notifications View and manage notifications notifications.md

Client & CRM

Command Description Docs
clients Client management clients.md
crm Customer relationship management crm.md
invoices Invoice management and billing invoices.md
proposals Project proposals proposals.md

Configuration & Setup

Command Description Docs
auth Authentication — login, logout, status auth.md
config Configuration — global and project settings config.md
init Initialize GitScrum in a repository init.md
hooks Git hooks integration hooks.md

Quick Start

# Authenticate
gitscrum auth login

# Set defaults
gitscrum config set workspace my-company
gitscrum config set project my-project

# Start working
gitscrum tasks current
gitscrum timer start

Global Flags

All commands support these flags:

Flag Description
--json Output in JSON format
-q, --quiet Minimal output (IDs only)
--no-color Disable colored output
--help Show command help

Common Workflows

Developer Daily Routine

# Morning
gitscrum notifications               # Check what's new
gitscrum tasks                       # What's on my plate?
gitscrum sprints current             # How's the sprint going?
gitscrum tasks branch GS-XXX         # Start working on a task
gitscrum timer start                 # Track my time

# Throughout the day
gitscrum tasks current               # What am I working on?
gitscrum timer                       # How long have I been working?
gitscrum chat                        # Check team messages

# End of day
gitscrum timer stop                  # Log my time
gitscrum timer report --day          # Review my day
gitscrum standup                     # Prepare for tomorrow

Sprint Planning

# Create new sprint
gitscrum sprints create -n "Sprint 13" --start 2026-03-01 --end 2026-03-14

# Add tasks
gitscrum tasks update GS-XXX --sprint sprint-13

# Review analytics
gitscrum analytics velocity

# Close current sprint
gitscrum sprints close sprint-12

Agency/Freelancer Workflow

# View clients
gitscrum clients

# Check time for billing
gitscrum timer report --month -p client-project

# Generate invoice
gitscrum invoices create --client techstart --period last-month

# Manage proposals
gitscrum proposals

CI/CD Integration

# Set up authentication
export GITSCRUM_ACCESS_TOKEN="your-token"

# Update task status
gitscrum tasks update $TASK_CODE --status "in review"

# Log deployment
gitscrum timer log $TASK_CODE 5m -d "Deployment"

See Also