nudge: Instructions file for Claude Code

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

The Spirit of Nudge

Nudge is a collaborative partner, not a rule enforcer. It helps you remember coding conventions so you can focus on the user's actual problem. Internalize these points:

1. Nudge is on your side. When it sends a message, that's a colleague tapping your shoulder, not a reprimand.
2. Direct does not mean hostile. Messages are blunt because that's what cuts through when you're focused. Trust the feedback.
3. Don't route around it. If you're tempted to work around a Nudge message, pause. Either follow the rule, or flag that the rule needs fixing.

For the full philosophy (why Nudge exists, the "collaborative memory layer" framing, the rally copilot analogy), see README.md.

Working on Nudge Itself

Nudge is dogfooded here. Your experience using it is direct feedback:

• Rule feels unclear? That's signal to improve the wording. Mention it.
• Rule feels wrong? Let's fix the rule, not route around it.

Build and Test Commands

# Build
cargo build -p nudge

# Run all tests
cargo test -p nudge

# Run a specific test
cargo test -p nudge test_name

# Run the CLI
cargo run -p nudge -- claude hook      # Respond to Claude hook (reads JSON from stdin)
cargo run -p nudge -- claude setup     # Install hooks, bundled skills, and commands for Claude
cargo run -p nudge -- claude skills install # Install the bundled Claude skills
cargo run -p nudge -- codex hook       # Respond to Codex hook (reads JSON from stdin)
cargo run -p nudge -- codex setup      # Install hooks and bundled skills for Codex
cargo run -p nudge -- codex skills install # Install the bundled Codex skills
cargo run -p nudge -- grok hook        # Respond to Grok Build hook (reads JSON from stdin)
cargo run -p nudge -- grok setup       # Install hooks and bundled skills for Grok Build
cargo run -p nudge -- grok skills install # Install the bundled Grok skills
cargo run -p nudge -- cursor hook      # Respond to Cursor hook (reads JSON from stdin)
cargo run -p nudge -- cursor setup     # Install hooks and bundled skills for Cursor
cargo run -p nudge -- cursor skills install # Install the bundled Cursor skills
cargo run -p nudge -- login typesafe.ai # Verify and save a TypeSafe API key
cargo run -p nudge -- learn add        # Record a repo-local learned incident note
cargo run -p nudge -- learn search     # Search learned incident notes
cargo run -p nudge -- learn embeddings # Manage local learned-note embeddings
cargo run -p nudge -- test             # Test a rule against sample input
cargo run -p nudge -- validate         # Validate rule config files
cargo run -p nudge -- check            # Check project files against rules (for CI)