Quickstart: Web + CLI in 10 Minutes

This guide gets you from zero to first useful entries.

Before you start

• You can access the Workrail web app.
• Your local repository already has commits.
• You are running commands from repository root.

Step 1Create your first project

In the dashboard, open Projects and create one project that matches your repository.

Step 2Authenticate the CLI

workrail auth login

Then confirm session status:

workrail auth status

Step 3Link your repository

From repository root:

workrail link

Choose the project created in Step 1.

Step 4Run first sync

workrail sync

If you want an initial backfill:

workrail sync --since 7d

Step 5Review entries in the app

Open Entries and improve high-impact items:

• Tighten title wording.
• Add why-it-mattered context.
• Add concrete outcomes when available.

Common setup issues

• Auth expired: run workrail auth login again.
• Wrong project link: run workrail unlink, then workrail link.
• No entries: confirm repo has commits in chosen time range.