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:

​
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:

​
Command reference

Authentication and account access.
Supports browser-based login for interactive users and access token authentication for CI and automation workflows.
Local CLI configuration.
Manage local defaults, select workspaces or environments, and configure output and profile settings.
Initialize a project or local platform configuration.
Bootstrap local project settings, create configuration files, and connect local repositories to the platform.
Project and workspace operations.
View and manage projects, connect repositories or services, and inspect workspace state.
Environment and secrets management.
Manage environment configuration, sync variables between local and remote environments, and support deployment workflows.
Deployment and release operations.
Trigger deployments, inspect release state, and support operational workflows and CI pipelines.
Logs and runtime diagnostics.
Inspect runtime output, tail logs from services or agents, and support debugging and operational visibility.
Platform and service status.
Inspect platform health, check service availability, and view environment or deployment state.
Agent operations.
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.
Test API access, make authenticated API calls, and inspect API metadata and schemas.
Talent network operations.
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:

​
Output

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

​
Example workflows

1

Login and initialize

2

Check project status

3

Deploy and tail logs

4

Run an agent

​
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