_____ _
/ ___| | |
\ `--. _ _ _ __ __| | __ _ ___
`--. \ | | | '_ \ / _` |/ _` |/ _ \
/\__/ / |_| | | | | (_| | (_| | __/
\____/ \__,_|_| |_|\__,_|\__,_|\___|
Sundae CLI Guide
pages$ man sundae
What is the Sundae CLI?
The Sundae CLI is a single-file Ruby command-line client for managing your tickets without leaving the terminal. View, create, update, and track tickets — all from the command line.
Requirements
- Ruby (any recent version — 2.7+)
- macOS or Linux (works anywhere Ruby runs)
- A Sundae Tickets account
Installation
Download the CLI with a single command:
curl -o /usr/local/bin/sundae https://sundae.cherryinspect.com/cli/tickets && chmod +x /usr/local/bin/sundae
Download and make executable
Or if you prefer a different location:
curl -o ~/bin/sundae https://sundae.cherryinspect.com/cli/tickets && chmod +x ~/bin/sundae
Install to ~/bin instead
Verify the installation:
sundae version
Should print the current CLI version
Login
Authenticate with your Sundae Tickets server:
sundae login https://sundae.cherryinspect.com
Interactive login — prompts for email and password
sundae login https://sundae.cherryinspect.com --token YOUR_TOKEN
Token-based login — for API tokens or CI environments
Your credentials are saved to ~/.sundaerc (file permissions set to 0600).
Viewing Tickets
sundae list
List all tickets in a table
sundae mine
Show only your assigned tickets (excludes completed)
sundae show 42
Show full details for ticket #42
sundae show 42 --json
Output ticket #42 as raw JSON
Filtering Tickets
Use filter flags with sundae list:
sundae list --status todo
Filter by status
sundae list --priority high
Filter by priority
sundae list --assignee alice
Filter by assignee
sundae list --label Bug
Filter by label
sundae list --q "search term"
Search tickets by keyword
sundae list --status "in progress" --assignee bob
Combine multiple filters
Creating & Updating Tickets
sundae create "Fix login bug" --priority high --assign alice --label Bug
Create a new ticket with options
sundae update 42 --status "in progress" --points 5
Update ticket fields
sundae status 42 testing
Quick status change
sundae assign 42 alice bob
Assign users to a ticket
sundae comment 42 "Fixed in commit abc123"
Add a comment to a ticket
Available flags for create/update
--title
Set the ticket title
--description
Set the description
--status
Set status (none, future, todo, in progress, testing, QA, completed)
--priority
Set priority (lowest, low, medium, high, highest, blocker)
--points
Set story points (1, 2, 3, 5, 8, 13, 21)
--assign
Assign a user (repeatable)
--label
Add a label (repeatable)
Other Commands
sundae whoami
Show your user info, assigned tickets, and point capacity
sundae notifications
Show your notifications
sundae users
List all users
sundae labels
List all labels
sundae logout
Remove saved credentials
sundae help
Show built-in help text
Updating the CLI
The CLI checks for updates once per day. To update manually:
sundae update-cli
Download the latest version from the server
Quick Links