CLI
CLI Command Reference
Reference for core Workrail CLI commands used day-to-day.
Updated 2026-02-16
Use this page as your day-to-day command reference.
Recommended order
- Authenticate
- Link repository (or workspace)
- Sync
- Review entries in the app
Command index
| Area | Command | What it does |
|---|---|---|
| Auth | workrail auth login |
Starts browser login and stores local session credentials |
| Auth | workrail auth status |
Confirms whether this terminal session is authorized |
| Repo | workrail link |
Links current repository to a Workrail project |
| Repo | workrail repos sync |
Refreshes local linked-repo list from the API |
| Repo | workrail unlink |
Removes local repository mapping |
| Workspace | workrail workspace add [path] --depth 8 |
Tracks all repos under a folder (no backfill) |
| Workspace | workrail workspace list |
Lists configured workspaces |
| Workspace | workrail workspace remove |
Removes workspace and unlinks discovered repos |
| Sync | workrail sync |
Runs incremental sync from last checkpoint |
| Sync | workrail sync --since 7d |
Backfills recent history for setup/debugging |
| Entry | workrail entry add |
Create an achievement entry manually |
| Autosync | workrail autosync enable |
Enables background sync |
| Autosync | workrail autosync status |
Shows autosync state |
| Autosync | workrail autosync disable |
Disables background sync |
| Summary | workrail summary daily |
Generates daily recap |
| Summary | workrail summary weekly |
Generates weekly summary draft |
| Summary | workrail summary --date 2026-02-11 |
Generates a daily summary for a specific local calendar day |
| Summary | workrail summary --from 2026-02-01 --to 2026-02-20 |
Generates an inclusive custom date-range summary |
| Summary | workrail summary --since 20d |
Generates summary for custom rolling range (max 90 days) |
Authentication
workrail auth login
workrail auth status
Typical use cases
- New machine setup: run
workrail auth login - Auth issue triage: run
workrail auth status - Account switch or expired token: run
workrail auth loginagain
Repository linking
workrail link
workrail repos sync
workrail unlink
Keep one repository linked to the correct project before syncing.
Workspace commands
Use workspaces when you have multiple repos inside one parent folder.
workrail workspace add ~/Projects --depth 8
workrail workspace list
workrail workspace remove
Notes:
- Workspace linking is intentionally no-backfill
- New repos under that folder are discovered on future syncs
- Prefer workspace mode for monorepo + service-repo setups
Syncing
workrail sync
workrail sync --since 7d
Best practice: run
workrail syncafter your main coding block (for example once daily), then quickly tighten high-impact entries in the app.
Manual entry creation
Use workrail entry add to create achievement entries for work that isn't captured by git sync:
workrail entry add
This opens an interactive workflow:
- Select project - Choose which project this entry belongs to
- Title - What did you achieve?
- Category - Feature, Bug Fix, Technical Decision, Learning, Mentorship, Meeting, or Other
- Impact - Rate from 1 (minimal) to 5 (critical)
- Tags - Comma-separated keywords (e.g., "redis, caching, api")
- Description - Opens your preferred editor with a template
When to use manual entries
- Design decisions and architecture discussions
- Mentorship and code review sessions
- Team meetings with outcomes
- Learning and skill development
- Non-code contributions (documentation, process improvements)
Tips for good entries
- Write for your future self (6 months from now)
- Include context: what was the problem?
- Describe what changed and why it mattered
- Add concrete outcomes or metrics when possible
Autosync
workrail autosync enable
workrail autosync status
workrail autosync disable
Use autosync on your primary development machine to reduce manual overhead.
Summary commands
workrail summary daily
workrail summary weekly
workrail summary --date 2026-02-11
workrail summary --from 2026-02-01 --to 2026-02-20
workrail summary --since 20d
Daily and date-based summaries use your local machine timezone so results match your actual day.
Use --from/--to for inclusive date windows, and note custom summary windows are capped at 90 days.
Practical workflows
First-time setup
workrail auth login
workrail link
workrail sync --since 7d
Daily workflow
workrail sync
If sync quality looks weak
- Improve commit subject clarity.