Quick Start

Get up and running with crosslink in under a minute.

1. Install

cargo install crosslink

See Installation for more options.

2. Initialize

cd your-project
crosslink init

This creates:

  • .crosslink/ — config, rules, and database
  • .claude/hooks/ — behavioral hooks for Claude Code
  • .claude/settings.json — hook configuration

3. Start a Session

crosslink session start

If a previous session left handoff notes, you’ll see them here.

4. Create Issues

# Simple issue
crosslink create "Fix login bug" -p high

# Quick mode: create + label + start working
crosslink quick "Fix login bug" -p high -l bug

5. Work on Issues

# Mark what you're working on
crosslink session work 1

# Record breadcrumbs as you go (survives context compression)
crosslink session action "Found root cause in refresh_token()"

# Add comments with findings
crosslink comment 1 "The token wasn't being refreshed on 401 responses"

6. End Your Session

crosslink session end --notes "Fixed auth bug #1. Dark mode (#2) is next."

The next session will see these handoff notes automatically.

What’s Next?