Command-Line Interface

GForge from your terminal

Manage tickets, create branches, and automate DevOps workflows without leaving your development environment. Native support for Git and Subversion, plus direct API access.

  • Keyboard-driven ticket management
  • Git and SVN branch integration
  • Raw API access for scripting
  • Single binary—macOS, Linux, Windows
gforge-cli
$ gforge ticket list
ID | Summary | Status | Priority
#1234 | Fix login timeout | In Progress | High
#1235 | Update API docs | Open | Medium
$ gforge branch “fix-login-timeout-#1234”
✓ Created branch: fix-login-timeout-#1234
$ gforge api /api/trackeritem/1234
{“id”:1234,”summary”:”Fix login timeout”,…}

Get gforge-cli

Single binary, zero dependencies. Download and go.

Up and running in 60 seconds

Download the binary, authenticate once, and start managing GForge from your terminal.

  1. 1

    Download & Install

    Grab the binary for your platform and add to your PATH

  2. 2

    Authenticate

    Run gforge login with your GForge server URL

  3. 3

    Configure (optional)

    Set repo_type to svn if using Subversion

  4. 4

    Start Working

    List tickets, create branches, hit the API directly

terminal
# Download (macOS Apple Silicon example) curl -LO your-download-url chmod +x gforge-darwin-arm64 mv gforge-darwin-arm64 /usr/local/bin/gforge # Authenticate gforge login –server your-gforge-server.com # For SVN users (Git is default) gforge config set repo_type svn # Verify gforge –version gforge ticket list

Built for Developer Workflows

Stay in flow. Manage your entire workflow without leaving the terminal.

Keyboard-First

Tab completion, intuitive commands, instant feedback. Your mouse stays untouched.

Git & SVN Support

Create branches with embedded ticket IDs. Works with both Git (git checkout -b) and Subversion (svn copy).

Workflow Transitions

Move tickets through your workflow without context switching. View valid transitions and update status in one command.

Raw API Access

Hit any GForge API endpoint directly with gforge api. Supports GET, POST, PUT, DELETE with JSON payloads.

Secure Auth

Single sign-on with credentials stored in ~/.config/gforge/config.json. Supports GFORGE_SERVER env var for CI/CD.

Zero Dependencies

Single binary. No runtime. Automatic detection of git/svn binaries with helpful errors if missing.

Automatic Commit Linking

GForge automatically associates commits with tickets. Two methods:

Link Commits to Tickets Automatically

When you create branches with gforge-cli, commits are automatically linked to the associated ticket—no extra work required.

Branch Name Method (Recommended)

Include ticket number in branch name. All commits on this branch link automatically.

gforge branch "fix-login-#1234"
→ Creates: fix-login-#1234

Commit Message Method

Include ticket reference in your commit message for manual linking.

git commit -m "Fix timeout [#1234]"

Where gforge-cli Shines

From solo developers to enterprise CI/CD pipelines.

CI/CD

Pipeline Automation

Update ticket status when builds pass or fail. Close tickets on merge. Keep your tracker in sync with deployments.

# In your CI pipeline
gforge ticket transition $TICKET_ID “Fixed: Test for Release”
Scripting

Raw API Access

Hit any endpoint directly. Combine with jq for powerful automation scripts.

# Get user’s tickets as JSON
gforge api /api/user/johndoe/trackeritems | jq ‘.[]’

# Update a ticket
gforge api /api/trackeritem/1234 -X POST -d ‘{“summary”:”New title”}’
Development

Branch Management

Start work by creating a linked branch—Git or SVN. Ticket ID embeds in the branch name, connecting commits automatically.

# Git (default)
gforge branch 4521 “fix-auth”

# SVN
gforge config set repo_type svn
gforge branch 4521 “fix-auth”
Productivity

Daily Standups

Review assigned tickets before standup. See status, priority, and details without opening a browser.

# List your in-progress tickets
gforge ticket list –status=”In Progress”

# View full details
gforge ticket view 1234

Command Reference

All commands for everyday use.

Command Description
gforge login Authenticate with GForge. Supports --server flag, GFORGE_SERVER env var, or interactive prompt.
gforge ticket list View all tickets assigned to you in a formatted table.
gforge ticket view <id> Display full ticket details: summary, status, priority, assignees, custom fields, description (HTML stripped).
gforge ticket transitions <id> List valid workflow transitions for a ticket.
gforge ticket transition <id> “Status” Move a ticket to a new status through the workflow.
gforge branch <id> “desc” Create a branch linked to a ticket. Uses git checkout -b or svn copy based on repo_type.
gforge api <endpoint> Make authenticated API requests. Supports -X for method (GET/POST/PUT/DELETE) and -d for JSON body.
gforge config list Display all configuration settings.
gforge config get <key> Get a specific config value.
gforge config set <key> <value> Update config. Keys: server, branch.prefix, repo_type (git or svn).