singularity-cli

singu is a Bun-based CLI client for the Singularity task manager API.

This is an unofficial CLI client and is not affiliated with or endorsed by Singularity. Use of the API remains subject to Singularity's own product terms, billing model, and access controls.

Install

Global install with Bun:

bun add -g singularity-cli

Then run:

singu --help

Status

Current scope:

• auth is implemented
• project read flows are implemented
• task read flows are implemented
• task write flows for capture, move, and scheduling are implemented
• project write flows are not implemented yet
• block capture is implemented

Project commands are read-only for now:

• singu project list
• singu project get <reference>
• singu project alias set <name> <reference>
• singu project alias list
• singu project alias remove <name>

Task commands available today:

• singu task list
• singu task list --inbox
• singu task list --project <project-ref>
• singu task list --all
• singu task get <reference>
• singu task add "title"
• singu task edit <reference> --title "new title"
• singu task move <reference> --project <project-ref>
• singu task move <reference> --inbox
• singu task schedule <reference> --start <when>
• singu task unschedule <reference>
• singu task rm <reference>
• singu task do <reference>
• singu task undo <reference>
• singu task alias set <name> <reference>
• singu task alias list
• singu task alias remove <name>
• singu block <duration> "title"

Not implemented yet:

• project create
• project update
• project delete
• task delete

Stack

• Bun
• TypeScript
• citty
• Kubb
• GRACE workflow and docs

Development

Install dependencies:

bun install

Refresh the local OpenAPI snapshot:

bun run spec:sync

Regenerate the SDK from the local snapshot:

bun run codegen

Run both in sequence:

bun run api:refresh

Type-check:

bun run check

Run tests:

bun run test

Run the CLI directly:

bun run cli --help

Build the standalone binary:

bun run build

This produces ./singu.

Auth

Auth uses a single bearer token.

Commands:

• singu auth login
• singu auth status
• singu auth logout

Rules:

• SINGULARITY_TOKEN overrides the saved token
• the saved token is stored locally in config storage
• auth login validates the token against the API by default

Examples:

singu auth login --token "<token>"
singu auth status
singu auth status --check
singu auth logout

Project References

Project commands accept three kinds of references:

• raw Singularity id
• short id from the last project list, for example 1
• alias, for example @inbox

Examples:

singu project list
singu project get 1
singu project get @inbox
singu project get id:raw-project-id

Task References

Task commands accept the same three kinds of references:

• raw Singularity id
• short id from the last task list, for example 1
• alias, for example @today

Examples:

singu task list
singu task list --inbox
singu task list --project @work
singu task list --all
singu task add "Call Peter"
singu task edit 1 --title "Call Peter about the release"
singu task move 1 --project @work
singu task move 1 --inbox
singu task schedule 1 --start tomorrow
singu task schedule 1 --start 2026-04-03T09:00:00.000Z --deadline 2026-04-03T10:00:00.000Z
singu task unschedule 1
singu task get 1
singu task get @today
singu task do 1
singu task undo 1
singu task rm 1
singu block 1h "Deep work on pet project"
singu task get id:raw-task-id

Default task list is an actionable view, not a raw dump.

By default it shows open tasks that are:

• scheduled for today
• scheduled earlier than today and still not completed

Default actionable output is sorted by start asc.

Useful task list modes:

• singu task list for the default actionable view
• singu task list --inbox for unscheduled tasks without a project
• singu task list --project <project-ref> to narrow the view to one project
• singu task list --all for the raw list without smart filtering

Short IDs And Aliases

Short IDs

singu project list prints numeric SID values and saves the latest list context locally.

That allows follow-up commands like:

singu project get 1

Short IDs are contextual:

• they come from the most recent project list
• they are scoped to the active auth token fingerprint
• they are not stable permanent ids

Aliases

Aliases are stable local names that point to raw project ids.

Examples:

singu project alias set inbox 1
singu project alias list
singu project get @inbox
singu project alias remove inbox

Alias behavior:

• aliases are stored locally
• aliases are scoped to the active auth token fingerprint
• aliases do not depend on the last-list SID cache once saved

Task aliases work the same way:

singu task alias set today 1
singu task alias list
singu task get @today
singu task alias remove today

Local Storage

By default:

• config lives in $XDG_CONFIG_HOME/singu or ~/.config/singu
• cache lives in $XDG_CACHE_HOME/singu or ~/.cache/singu

Used files:

• config.json for the saved token
• aliases.json for project aliases
• project-last-list.json for project SID cache
• task-last-list.json for task SID cache

If SINGU_HOME is set, everything is stored under that root instead:

• config.json
• aliases.json
• cache/project-last-list.json
• cache/task-last-list.json

OpenAPI And SDK

The CLI does not generate from a live remote OpenAPI URL during codegen.

Workflow:

1. bun run spec:sync fetches the upstream Swagger UI bootstrap
2. it extracts the embedded swaggerDoc
3. it writes openapi/swagger.json
4. bun run codegen generates the SDK from that local file

Generated code lives in:

• src/api/generated

Current CLI Surface

Top-level commands:

• singu auth
• singu project
• singu task
• singu block

Project subcommands today:

• list
• get
• alias set
• alias list
• alias remove

Task subcommands today:

• list
• get
• add
• edit
• move
• schedule
• unschedule
• rm
• do
• undo
• alias set
• alias list
• alias remove

The README should stay aligned with the actual implemented command surface.