@we-scrum/cli

Command-line tool for the we-scrum application.

Installation

npm install -g @we-scrum/cli

Authentication

Authentication uses Google OAuth2. Credentials are stored locally in ~/.we-scrum.json and refreshed automatically on each use.

we-scrum login    # Authenticate with your Google account
we-scrum logout   # Remove stored credentials

Commands

Select a project

we-scrum use-project                    # Interactive project picker
we-scrum use-project --projectId <id>   # Set project directly

The selected project is persisted in ~/.we-scrum.json and used by all subsequent commands.

Development policies

we-scrum synchronize-development-policies   # Sync development guidelines from we-scrum into the project

Story analysis

we-scrum get-story-description --identificationNumber <id>   # Get the description of a story
we-scrum get-story-analysis --identificationNumber <id>      # Get the analysis DSL for a story

Story development

we-scrum get-next-task --identificationNumber <id>

Gets the next pending task (status: ToDo) for a story, including its description, type template, section analysis, and the IDs needed to start or complete it.

If the next task is paused by an automation breakpoint, this command stops and reports the pause instead of returning task details — see Automation breakpoints below.

we-scrum start-task --identificationNumber <id> --changeId <changeId>      # Mark a specific task as in progress
we-scrum complete-task --identificationNumber <id> --changeId <changeId>   # Mark the current in-progress task as done

Change threads

Change threads are conversations attached to a change (task) in the we-scrum web app. They are used to request adjustments on a task, and to report deviations from the task description or feedback on the development guidelines.

we-scrum get-change-threads --changeId <changeId>                                            # List all threads of a change (any status), with their comments
we-scrum create-change-thread --changeId <changeId> --comment <comment>                      # Open a new thread with a first comment
we-scrum add-comment-to-change-thread --changeThreadId <id> --comment <comment>              # Reply to an existing thread
we-scrum update-change-thread-status --changeThreadId <id> --status <Open|Resolved|Archived> # Change the status of a thread

Comments support markdown. get-change-threads returns every thread of the change, whatever its status (Open, Resolved, Archived), ordered by status (Open first, then Resolved, then Archived) and, within a status, by creation date. This gives the complete history and lets you reply to an existing thread instead of creating a duplicate.

The get-next-task output tells you when to use these commands: read the threads before implementing, resolve the open ones you addressed, and before completing a task post a thread for any deviation from the task description or for missing development guidelines.

Automation breakpoints

A developer can set a breakpoint on a change from the we-scrum web app to pause automated development at that point. When get-next-task hits a change with a breakpoint set, it halts and reports the pause instead of proceeding.

we-scrum remove-automation-breakpoint --automationBreakpointId <id>

Clears the breakpoint so development can resume. The id is included in the get-next-task output when a breakpoint is hit.

Iterations

we-scrum update-iteration --name <name> [--capacity <capacity>] [--comment <comment>] [--startDate <date>] [--endDate <date>]

Requirements

• Node.js 22+