Skip to main content

CLI Reference

Complete reference for Goblin CLI commands.

Global Options​

goblin [OPTIONS] COMMAND [ARGS]

Options:
  --version  Show version
  --help     Show help

Quick Reference​

CommandDescription
goblin initInitialize workspace
goblin daemonStart background orchestrator
goblin statusView current status
goblin docsOpen documentation
goblin app upStart Hello Goblin webapp

Core Commands​

goblin init​

Initialize Goblin workspace.

goblin init [PATH] [--force]

Creates .goblin/ directory with database and configuration.

goblin auth​

Authenticate with Linear.

goblin auth --token TOKEN --org ORG_NAME

goblin sync​

Sync issues from Linear.

goblin sync -p PROJECT_ID

goblin status​

View current status dashboard.

goblin status

goblin dashboard​

Open web dashboard.

goblin dashboard [--port PORT]

goblin daemon​

Start the Goblin daemon.

goblin daemon

goblin docs​

Open documentation in browser.

goblin docs [--port PORT] [--build]

Options:

  • --port - Port number (default: 3846)
  • --build - Build and serve static site

Pipeline Commands​

goblin pipeline start​

goblin pipeline start ISSUE_ID

goblin pipeline status​

goblin pipeline status ISSUE_ID

goblin pipeline retry​

goblin pipeline retry ISSUE_ID

goblin pipeline cancel​

goblin pipeline cancel ISSUE_ID

goblin pipeline config​

goblin pipeline config -p PROJECT_ID [OPTIONS]

Options:

  • --assignee-id ID - Bot user ID
  • --docker-compose FILE - Docker Compose file
  • --test-urls URLS - Test URLs
  • --playwright - Enable Playwright
  • --config KEY=VALUE - Set config value
  • --show - Show current config

Agent Commands​

goblin agent spawn​

goblin agent spawn ISSUE_ID

goblin agent list​

goblin agent list [-s STATUS]

goblin agent logs​

goblin agent logs AGENT_ID

goblin agent kill​

goblin agent kill AGENT_ID

goblin attach​

goblin attach AGENT_ID

Project Commands​

goblin project add​

goblin project add PATH --team TEAM_KEY [--name NAME]

goblin project list​

goblin project list

goblin project remove​

goblin project remove PROJECT_ID

Specialist Commands​

goblin specialist spawn​

goblin specialist spawn --type TYPE --issue ISSUE_ID

Types: ceo, reviewer, devops, qa, security, performance, docs

goblin specialist list​

goblin specialist list

Preview Commands​

goblin preview list​

goblin preview list [OPTIONS]

Options:

  • -p, --project - Filter by project name
  • -a, --all - Show all (including stopped)

goblin preview info​

goblin preview info ISSUE_ID

Show detailed info about a preview environment.

goblin preview urls​

goblin preview urls ISSUE_ID

goblin preview logs​

goblin preview logs ISSUE_ID [OPTIONS]

Options:

  • -f, --follow - Follow log output
  • -s, --service - Specific service
  • -n, --tail - Number of lines (default: 100)

goblin preview ps​

goblin preview ps ISSUE_ID

Show container status for a preview.

goblin preview exec​

goblin preview exec ISSUE_ID [SERVICE] [COMMAND]

Execute a command in a preview container.

  • Default service: web
  • Default command: bash

goblin preview restart​

goblin preview restart ISSUE_ID [OPTIONS]

Options:

  • -s, --service - Specific service to restart

goblin preview stop​

goblin preview stop ISSUE_ID

For local: tears down Docker containers. For cloud: destroys the EC2/DigitalOcean instance.

goblin preview ssh​

goblin preview ssh ISSUE_ID

SSH into a cloud preview instance (EC2/DigitalOcean only).

goblin preview extend​

goblin preview extend ISSUE_ID [OPTIONS]

Options:

  • -h, --hours - Hours to extend TTL (default: 2)

Extend the TTL of a cloud preview to prevent auto-expiration.

Remote Commands​

goblin remote set​

goblin remote set --name NAME --ip IP --ssh-key PATH [OPTIONS]

Options:

  • --instance-id - EC2 instance ID
  • --region - AWS region

goblin remote logs​

goblin remote logs [-f] [-l LINES]

goblin remote status​

goblin remote status

goblin remote restart​

goblin remote restart

goblin remote ssh​

goblin remote ssh

Webapp Commands (Hello Goblin)​

Manage the Hello Goblin financial management webapp.

goblin app up​

Start webapp containers.

goblin app up [--detach] [--build] [--prod]

Options:

  • -d, --detach - Run in background (default: true)
  • -b, --build - Build images first
  • -p, --prod - Use production config

goblin app down​

Stop webapp containers.

goblin app down [--volumes] [--prod]

Options:

  • -v, --volumes - Remove volumes too
  • -p, --prod - Use production config

goblin app logs​

View webapp logs.

goblin app logs [--follow] [--service SERVICE] [--tail N]

Options:

  • -f, --follow - Follow log output (default: true)
  • -s, --service - Specific service (backend, frontend, etc.)
  • -n, --tail - Number of lines (default: 100)

goblin app status​

Show container status.

goblin app status [--prod]

goblin app restart​

Restart services.

goblin app restart [--service SERVICE] [--prod]

goblin app build​

Build containers.

goblin app build [--no-cache] [--service SERVICE] [--prod]

goblin app shell​

Open shell in container.

goblin app shell [--service SERVICE]

Default service: backend

goblin app open​

Open webapp in browser.

goblin app open

Opens http://localhost:3001

goblin app deploy​

Deploy to production server.

goblin app deploy [OPTIONS]

Options:

  • -h, --host - Server IP/hostname (default: 3.16.148.197)
  • -u, --user - SSH user (default: ubuntu)
  • -k, --key - SSH private key path
  • --skip-build - Skip container rebuild
  • --skip-nginx - Skip nginx config update

Deploys the full stack:

  • Frontend → hellogobl.in
  • Backend API → hellogobl.in/api
  • Docs → docs.hellogobl.in

Utility Commands​

goblin whoami​

Show current Linear user.

goblin whoami

goblin issues​

List issues from Linear.

goblin issues [-p PROJECT_ID]

goblin clean​

Clean up stale resources.

goblin clean

goblin setup​

Interactive setup wizard.

goblin setup