Boards & Sprints
Boards & Sprints
Section titled “Boards & Sprints”Manage Scrum and Kanban boards, sprints, and backlogs.
Prerequisites
Section titled “Prerequisites”- Authenticated profile (
atlcli auth login) - Jira permission: Browse Projects (read), Manage Sprints (sprint operations)
Boards
Section titled “Boards”List Boards
Section titled “List Boards”atlcli jira board listOptions:
| Flag | Description |
|---|---|
--project | Filter by project key |
--type | Filter by type: scrum, kanban |
--name | Filter by name pattern |
--limit | Maximum results |
Examples
Section titled “Examples”# All boards for a projectatlcli jira board list --project PROJ
# Only Scrum boardsatlcli jira board list --type scrum
# Search by nameatlcli jira board list --name "Team"Get Board
Section titled “Get Board”atlcli jira board get --id 123Output:
Board: Team Scrum BoardID: 123Type: scrumProject: PROJ (Project Name)Filter: 10001
Columns: - To Do - In Progress - DoneBoard Issues
Section titled “Board Issues”Get all issues on a board:
atlcli jira board issues --id 123Options:
| Flag | Description |
|---|---|
--id | Board ID (required) |
--jql | Filter with JQL query |
--limit | Maximum results |
Backlog
Section titled “Backlog”View the backlog for a board:
atlcli jira board backlog --id 123Options:
| Flag | Description |
|---|---|
--id | Board ID (required) |
--limit | Maximum results |
Sprints
Section titled “Sprints”List Sprints
Section titled “List Sprints”atlcli jira sprint list --board 123Options:
| Flag | Description |
|---|---|
--board | Board ID (required) |
--state | Filter: active, future, closed |
--limit | Maximum results |
Examples
Section titled “Examples”# Active sprints onlyatlcli jira sprint list --board 123 --state active
# Future (planned) sprintsatlcli jira sprint list --board 123 --state futureGet Sprint
Section titled “Get Sprint”atlcli jira sprint get --id 456Output:
Sprint: Sprint 14ID: 456State: activeBoard: 123 (Team Scrum Board)Start: 2025-01-06End: 2025-01-17Goal: Complete API refactoring
Issues: 24 (18 done, 4 in progress, 2 to do)Points: 21 committed, 16 completedCreate Sprint
Section titled “Create Sprint”atlcli jira sprint create --board 123 --name "Sprint 15"Options:
| Flag | Description |
|---|---|
--board | Board ID (required) |
--name | Sprint name (required) |
--start | Start date (YYYY-MM-DD) |
--end | End date (YYYY-MM-DD) |
--goal | Sprint goal |
Examples
Section titled “Examples”# Create with datesatlcli jira sprint create --board 123 --name "Sprint 15" \ --start "2025-01-20" --end "2025-02-03"
# Create with goalatlcli jira sprint create --board 123 --name "Sprint 15" \ --goal "Complete user authentication feature"Start Sprint
Section titled “Start Sprint”Start a planned sprint:
atlcli jira sprint start --id 456Close Sprint
Section titled “Close Sprint”Close an active sprint:
atlcli jira sprint close --id 456Options:
| Flag | Description |
|---|---|
--id | Sprint ID (required) |
--confirm | Skip confirmation prompt |
Add Issues to Sprint
Section titled “Add Issues to Sprint”atlcli jira sprint add PROJ-1 PROJ-2 PROJ-3 --sprint 456Options:
| Flag | Description |
|---|---|
--sprint | Sprint ID (required) |
--issues | Comma-separated issue keys (alternative to positional args) |
Remove Issues from Sprint
Section titled “Remove Issues from Sprint”Move issues back to backlog:
atlcli jira sprint remove PROJ-1 PROJ-2Options:
| Flag | Description |
|---|---|
--issues | Comma-separated issue keys (alternative to positional args) |
Sprint Report
Section titled “Sprint Report”Get comprehensive sprint metrics:
atlcli jira sprint report --id 456Options:
| Flag | Description |
|---|---|
--id | Sprint ID (required) |
--points-field | Custom story points field ID |
--json | JSON output |
Output:
Sprint 14 Report================Duration: Jan 6 - Jan 17, 2025 (10 days)Status: Active
SUMMARY-------Total Issues: 24Completed: 18 (75%)In Progress: 4 (17%)Not Started: 2 (8%)
STORY POINTS------------Committed: 21Completed: 16Remaining: 5
SCOPE CHANGES-------------Added: 3 issuesRemoved: 1 issue
TOP CONTRIBUTORS----------------Alice: 8 issues completedBob: 6 issues completedCarol: 4 issues completedExport Sprint Report
Section titled “Export Sprint Report”# JSON for automation or documentationatlcli jira sprint report --id 456 --json > sprint-report.jsonJSON Output
Section titled “JSON Output”All commands support --json:
atlcli jira sprint list --board 123 --json{ "schemaVersion": "1", "sprints": [ { "id": 456, "name": "Sprint 14", "state": "active", "startDate": "2025-01-06", "endDate": "2025-01-17", "goal": "Complete API refactoring", "boardId": 123 } ]}Best Practices
Section titled “Best Practices”- Plan sprints in advance - Create future sprints so issues can be assigned
- Set sprint goals - Clear goals improve focus
- Use sprint reports - Review metrics to improve velocity
Related Topics
Section titled “Related Topics”- Analytics - Velocity and burndown charts
- Issues - Work with individual issues
- Bulk Operations - Batch updates on sprint issues
Jira and Confluence are trademarks of Atlassian Corporation Plc.
atlcli is not affiliated with, endorsed by, or sponsored by Atlassian.