GitScrum CLI

Command-line interface for GitScrum.
Manage projects, track time, and ship faster — without leaving your terminal.

Overview

GitScrum CLI gives you full access to your GitScrum workspace from the terminal. Tasks, time tracking, sprints, analytics — everything without leaving your editor.

⚠️ BETA: This CLI is in active development. While fully functional, you may encounter bugs or breaking changes. Report issues to help us improve!

# Your morning in 30 seconds
$ gitscrum tasks
CODE      TITLE                              STATUS         EFFORT
GS-1234   Implement OAuth flow               In Progress    5 pts
GS-1198   Fix pagination bug                 Todo           2 pts
GS-1201   Add caching layer                  Blocked        8 pts

$ gitscrum timer start GS-1234
Timer started for GS-1234 at 09:15

# ... 3 hours of coding ...

$ gitscrum timer stop
Logged 3h 12m to GS-1234
  Total today: 5h 45m

$ gitscrum sprints burndown
Sprint 12 — Day 7 of 10
52 │●
40 │  ●──●
30 │       ●──●
20 │            ●  ← You are here
10 │
 0 └─────────────────
    M  T  W  T  F

Remaining: 22 pts | Velocity: 5.2/day | On track

Git-aware. Team-ready. CI/CD compatible.

Quick start

Install

curl -sL https://raw.githubusercontent.com/gitscrum-core/cli/main/install.sh | sh

Or install via package managers:

brew install gitscrum-core/tap/gitscrum

scoop bucket add gitscrum https://github.com/gitscrum-core/scoop-bucket
scoop install gitscrum

go install github.com/gitscrum-core/cli/cmd/gitscrum@latest

Authenticate

gitscrum auth login

The CLI initiates an OAuth 2.0 Device Authorization Grant flow. Authorize in your browser — credentials are stored locally and never transmitted to third parties.

Configure

gitscrum config set workspace my-company
gitscrum config set project my-project

Commands

Core

Time Tracking

Tasks

Sprints

Team & Collaboration

Clients & Billing

Configuration

CRM (PRO)

Full reference: docs/commands/

Real-World Workflows

Branch → Code → PR → Done

# Pick your task and create a branch
$ gitscrum tasks branch GS-1234
Switched to branch 'feature/GS-1234-implement-oauth'

# Timer auto-starts when you checkout a task branch
$ gitscrum timer
Active: GS-1234 | Running: 45m

# After PR is opened
$ gitscrum tasks update GS-1234 --status "in review"
GS-1234 moved to In Review

# After merge
$ gitscrum tasks update GS-1234 --status done
GS-1234 marked as Done

Daily Standup

$ gitscrum standup
DAILY STANDUP — Feb 7, 2026
────────────────────────────────────────
  Completed yesterday:    4 tasks
  In progress:            2 tasks
  Blocked:                1 task
  
$ gitscrum standup blockers
BLOCKERS:
  [!] GS-1156 — Waiting on API spec (bob)

Team Time Report

$ gitscrum timer report --week --team
TEAM TIME — This Week

MEMBER      HOURS     TOP PROJECT
alice       38h 15m   backend-api
bob         32h 00m   web-app  
charlie     28h 45m   mobile-app

Total: 99h 00m | Avg: 33h/person

Git Integration

# Branch names auto-detect task codes
$ git checkout feature/GS-1234-oauth
$ gitscrum tasks current
GS-1234: Implement OAuth flow | In Progress | 5 pts

# Create branch from task
$ gitscrum tasks branch GS-1198
Created and switched to: fix/GS-1198-pagination-bug

Project Configuration

Create a .gitscrum.yml in your repository root to share settings across your team:

gitscrum init -w my-workspace -p my-project

version: "1"
workspace: my-company
project: my-project

branch:
  default_prefix: feature
  include_title: true
  max_length: 60

hooks:
  prepend_task_code: true
  commit_format: "[%s] %s"

automation:
  on_pr_merge: done
  complete_on_merge: true

Full options: docs/examples/.gitscrum.yml

CI/CD Integration

For headless environments, authenticate using an access token:

export GITSCRUM_ACCESS_TOKEN="your-oauth-access-token"
gitscrum tasks list

Examples

Common use cases:

• Sync PR/MR status with task status
• Auto-link commits to tasks
• Generate sprint reports on schedule
• Track deployments

Output Formats

gitscrum tasks              # Table output (default)
gitscrum tasks --json       # JSON for scripting
gitscrum tasks -q           # Quiet mode (IDs only)

Security

The CLI is designed around the principle of least privilege.

Found a vulnerability? Report privately to security@gitscrum.com.

Full details: SECURITY.md

Documentation

Development

git clone https://github.com/gitscrum-core/cli.git
cd cli
make build
make test

Full guide: CONTRIBUTING.md

Contributing

See CONTRIBUTING.md for guidelines.

git checkout -b feature/my-feature
# make changes, add tests
make test
git commit -m "feat: describe your change"

License

MIT — see LICENSE.

Website  ·  Docs  ·  Issues  ·  Changelog

Built by GitScrum