Commands reference
Every command is discoverable via --help. This page is the map: what's available, how it's organised, and the rules every command follows.
The shape, again
dimescheduler <entity> <verb> [flags]
<entity> is the entity in plural kebab-case (categories, resource-gps-trackings, …). <verb> is list, create, update, or delete. Most entities support all four; a few are read-only.
For create / update / delete, the flags mirror the entity's fields. Run dimescheduler <entity> <verb> --help to see them - the flag set is generated from the OpenAPI specification, so it can't drift from the API.
Top-level operational commands
These commands aren't tied to an entity:
dimescheduler auth login | logout | status
dimescheduler config get | set | list | path
dimescheduler api <method> <path> [--body ...] [--body-file ...]
dimescheduler completion bash | zsh | fish | powershell
dimescheduler version [--check-update]
auth and config are covered in Authentication. The rest are below.
Entities
Here's the full list of entity commands, grouped by how they relate. The first column is the command name (plural, kebab-case); the second lists any aliases the CLI also accepts.
Work items
| Entity | Aliases | Verbs |
|---|---|---|
jobs | job | list / create / update / delete |
tasks | task | list / create / update / delete |
task-containers | list / create / update / delete | |
task-filter-values | list / create / update / delete | |
task-locked | list / create / update / delete | |
task-uris | list / create / update / delete |
Resources
| Entity | Aliases | Verbs |
|---|---|---|
resources | resource, res | list / create / update / delete |
resource-calendars | list / create / update / delete | |
resource-capacities | list / create / update / delete - list requires --start and --end | |
resource-certificates | list / create / update / delete | |
resource-filter-values | list / create / update / delete | |
resource-gps-trackings | list / create / update / delete | |
resource-uris | list / create / update / delete | |
resource-types | list (read-only) |
Appointments
| Entity | Aliases | Verbs |
|---|---|---|
appointments | appointment, appt | list / create / update / delete - list requires --from and --to (RFC 3339) |
appointment-categories | list / create / update / delete | |
appointment-contents | list / create / update / delete | |
appointment-containers | list / create / update / delete | |
appointment-field-values | list / create / update / delete | |
appointment-importances | list / create / update / delete | |
appointment-locked | list / create / update / delete | |
appointment-planning-quantities | list / create / update / delete | |
appointment-time-markers | list / create / update / delete | |
appointment-uris | list / create / update / delete | |
assignments | assignment | list / create / update / delete |
appointment-dependencies | list (read-only) | |
appointment-fields | list (read-only) |
Filters and indicators
| Entity | Aliases | Verbs |
|---|---|---|
filter-groups | list / create / update / delete | |
filter-values | list / create / update / delete | |
categories | category, cat | list / create / update / delete |
time-markers | list / create / update / delete | |
pins | pin | list / create / update / delete |
Other
| Entity | Aliases | Verbs |
|---|---|---|
action-uris | action-uri | list / create / update / delete |
captions | caption | list / create / update / delete |
containers | container | list / create / update / delete |
notifications | notification | list / create / update / delete - list accepts --page, --limit, --sort, --group, --filter |
calendars | list (read-only) |
Special list flags
Most list commands take no arguments, but three need parameters:
# Date range (RFC 3339)
dimescheduler appointments list --from 2026-05-01T00:00:00Z --to 2026-05-31T23:59:59Z
dimescheduler appointments list --from 2026-05-01T00:00:00Z --to 2026-05-31T23:59:59Z \
--resource RES1 --resource RES2
# Date range (capacities use --start / --end, not --from / --to)
dimescheduler resource-capacities list --start 2026-05-01T00:00:00Z --end 2026-05-31T23:59:59Z
# Paginated notifications
dimescheduler notifications list --page 1 --limit 50 --sort createdAt:desc
api - the escape hatch
For endpoints the typed commands don't cover, api makes any authenticated request. It works the same way as gh api:
# GET
dimescheduler api GET /category
# POST with an inline body
dimescheduler api POST /category --body '{"name":"VIP","color":"#22d3ee"}'
# POST from a file
dimescheduler api POST /task --body-file ./task.json
# Query parameters
dimescheduler api GET /notification --query 'page=1&limit=50'
Output formatting and --jq work the same as for typed commands.
Completions
dimescheduler completion bash # source from .bashrc
dimescheduler completion zsh # source from .zshrc
dimescheduler completion fish # write to ~/.config/fish/completions/dimescheduler.fish
dimescheduler completion powershell # source from your PowerShell profile
Version & update check
dimescheduler version # print version
dimescheduler version --check-update # compare against GitHub releases
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Unexpected error (panic, internal bug). |
2 | Usage error (bad flags, missing required value). |
3 | Authentication error - missing or invalid API key. |
4 | API error - the server returned 4xx or 5xx. The response body is on stderr. |
5 | Network error - DNS, TCP, or TLS failure. |
Scripts can branch on these without parsing output. Combine with --quiet for clean set -e pipelines.