Skip to main content
The Scrums CLI is planned and not yet publicly available. This page describes the intended design and command structure. Commands and behaviour are subject to change before release.
The Scrums CLI gives you a fast, scriptable way to work with the Scrums platform from your terminal, CI pipelines, and internal tooling — without needing the web application for every action. The primary command is: 
scrums

​
Design principles

The CLI is built around five principles:
  • Brand-native — feels like a first-class part of the Scrums platform
  • Resource-based — predictable scrums <resource> <action> structure
  • Scriptable — works cleanly in automation, CI pipelines, and orchestrators
  • Human-readable by default — clear terminal output out of the box
  • Machine-readable when needed — --json flag for structured output

​
Command structure

All commands follow this pattern: 
scrums <resource> <action> [arguments] [flags]

scrums auth login
scrums projects list
scrums env set API_KEY=value
scrums deploy create --env production
scrums logs tail --service api
scrums agents run sync-org-codes

​
Command reference

Authentication and account access.
scrums auth login       # Sign in via browser
scrums auth logout      # Clear local session
scrums auth whoami      # Inspect active account
scrums auth token       # Manage access tokens for CI/CD
Supports browser-based login for interactive users and access token authentication for CI and automation workflows.
Local CLI configuration.
scrums config get
scrums config set
scrums config list
Manage local defaults, select workspaces or environments, and configure output and profile settings.
Initialize a project or local platform configuration.
scrums init
scrums init project
scrums init agent
Bootstrap local project settings, create configuration files, and connect local repositories to the platform.
Project and workspace operations.
scrums projects list
scrums projects create
scrums projects view <project-id>
scrums projects link
View and manage projects, connect repositories or services, and inspect workspace state.
Environment and secrets management.
scrums env list
scrums env pull
scrums env push
scrums env set KEY=value
scrums env remove KEY
Manage environment configuration, sync variables between local and remote environments, and support deployment workflows.
Deployment and release operations.
scrums deploy
scrums deploy create
scrums deploy list
scrums deploy rollback
Trigger deployments, inspect release state, and support operational workflows and CI pipelines.
Logs and runtime diagnostics.
scrums logs
scrums logs tail
scrums logs service <service-name>
Inspect runtime output, tail logs from services or agents, and support debugging and operational visibility.
Platform and service status.
scrums status
scrums status services
scrums status project <project-id>
Inspect platform health, check service availability, and view environment or deployment state.
Agent operations.
scrums agents list
scrums agents run <agent-name>
scrums agents logs <agent-name>
scrums agents status
Interact with platform agents, trigger agent workflows, and inspect execution and output. This command group is expected to grow significantly as Scrums expands its AI and orchestration capabilities.
API utilities for developers and operators.
scrums api whoami
scrums api call GET /v1/projects
scrums api openapi
Test API access, make authenticated API calls, and inspect API metadata and schemas.
Talent network operations.
scrums talent search
scrums talent view <talent-id>
scrums talent skills <talent-id>
Command-line access to talent-facing and operator-facing workflows. This area is planned but will be more limited than core platform commands in the first release.

​
Global flags

All commands support a standard set of global flags:
FlagDescription
--helpShow help for any command
--jsonOutput as structured JSON
--profileUse a named config profile
--workspaceTarget a specific workspace
--projectTarget a specific project
--envTarget a specific environment
--verboseShow detailed output
scrums projects list --json
scrums deploy create --env production --verbose

​
Output

By default, output is optimized for humans — compact, readable, and table or list based where appropriate. 
scrums projects list

  ID          NAME              STATUS
  proj-001    payments-api      active
  proj-002    auth-service      active
  proj-003    data-pipeline     inactive

​
Example workflows

1

Login and initialize

scrums auth login
scrums init
2

Check project status

scrums projects list
scrums status
3

Deploy and tail logs

scrums deploy create --env production
scrums logs tail
4

Run an agent

scrums agents run sync-org-codes

​
Planned v1 scope

The initial release will focus on core platform and developer workflows:

Included in v1

  • auth
  • config
  • init
  • projects
  • env
  • deploy
  • logs
  • status

Post-v1

  • agents
  • api
  • talent
  • integrations
  • marketplace
This page will be updated as the CLI moves from planned to available. Commands will be clearly marked as planned, available, or deprecated as the release progresses.
Last modified on March 13, 2026