agentleFS
qf-studioqf-studio/navigator/skills/nav-sync-claude/SKILL.md

nav-sync-claude

Skill355 starsChanged 13 months agoMITView on GitHub

Sync project CLAUDE.md to the installed Navigator version, preserving customizations. Use when user says "sync CLAUDE.md", "update CLAUDE.md", or when detecting outdated Navigator configuration.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

17 rules. About 0 are common, 9 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Update project's CLAUDE.md to latest Navigator version (v3.1) while preserving project-specific customizations.

    line 10
  2. Distinctive:

    DO NOT invoke: if:

    line 20
  3. Distinctive:

    Check if CLAUDE.md exists and detect version:

    line 29
  4. Very specific:

    Use version_detector.py to analyze CLAUDE.md:

    line 40
  5. Distinctive:

    If user declines, exit. If accepts, continue.

    line 75
  6. Distinctive:

    Always create backup before modifying:

    line 79
  7. Very specific:

    Use claude_updater.py to parse current CLAUDE.md:

    line 88
  8. Very specific:

    sections: every ## section in order, {"header", "body"}, bodies byte for byte (### subsections, fences and --- rules included)

    line 101
  9. Distinctive:

    Always up-to-date with release

    line 142
  10. Distinctive:

    If config exists, migrate to latest version with new sections:

    line 204
  11. Very specific:

    Check for version marker: Navigator Version: X.X.X

    line 258
  12. Very specific:

    Check for slash commands: /nav:start, /jitd:, etc.

    line 259
  13. Very specific:

    Check for natural language examples: "Start my Navigator session"

    line 260
  14. Distinctive:

    Check for skills section

    line 261
  15. Very specific:

    No version + no Navigator markers → unknown

    line 267
  16. Distinctive:

    If migration fails or user is unhappy:

    line 430
  17. Distinctive:

    nav-start: Start session (uses updated CLAUDE.md)

    line 466

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Navigator CLAUDE.md Updater Skill

Update project's CLAUDE.md to latest Navigator version (v3.1) while preserving project-specific customizations.

When to Invoke

Invoke this skill when the user:

  • Says "update my CLAUDE.md", "migrate CLAUDE.md to v3"
  • Says "update Navigator configuration", "fix my CLAUDE.md"
  • Mentions outdated commands like "/nav:start" and wants to upgrade
  • Complains that Claude doesn't understand Navigator workflow

DO NOT invoke if:

  • CLAUDE.md already references v3.1 and natural language commands
  • User is editing CLAUDE.md for project-specific reasons (not Navigator updates)
  • Working on plugin's root CLAUDE.md (not user projects)

Execution Steps

Step 1: Detect Current CLAUDE.md Version

Check if CLAUDE.md exists and detect version:

if [ ! -f "CLAUDE.md" ]; then
  echo "❌ No CLAUDE.md found in current directory"
  echo ""
  echo "Run 'Initialize Navigator in this project' first."
  exit 1
fi

Use version_detector.py to analyze CLAUDE.md:

PLUGIN_DIR="${CLAUDE_PLUGIN_ROOT:-$(cat "${NAVIGATOR_CONFIG_HOME:-${XDG_CONFIG_HOME:-$HOME/.config}/navigator}/plugin-root" 2>/dev/null)}"
[ -d "$PLUGIN_DIR/skills" ] || PLUGIN_DIR="$HOME/.claude/plugins/marketplaces/navigator-marketplace"
python3 "$PLUGIN_DIR/skills/nav-sync-claude/functions/version_detector.py" CLAUDE.md

This script checks for:

  • Version markers (e.g., "Navigator Version: 3.1.0")
  • Slash command references (/nav:start, /nav:doc, etc.)
  • Skills vs commands language
  • Natural language examples

Outputs:

  • outdated - Has /nav: commands or v1/v2 markers
  • current - Already v3.1 with natural language
  • unknown - Can't determine (custom/non-Navigator file)

If current:

✅ CLAUDE.md is already up to date (v3.1)

No migration needed.

Exit successfully.

If unknown:

⚠️  CLAUDE.md doesn't appear to be a Navigator file

This might be a custom configuration. Manual review recommended.
Proceed with migration anyway? [y/N]

If user declines, exit. If accepts, continue.

Step 2: Backup Current CLAUDE.md

Always create backup before modifying:

cp CLAUDE.md CLAUDE.md.backup
echo "📦 Backup created: CLAUDE.md.backup"

Step 3: Extract Project-Specific Customizations

Use claude_updater.py to parse current CLAUDE.md:

PLUGIN_DIR="${CLAUDE_PLUGIN_ROOT:-$(cat "${NAVIGATOR_CONFIG_HOME:-${XDG_CONFIG_HOME:-$HOME/.config}/navigator}/plugin-root" 2>/dev/null)}"
[ -d "$PLUGIN_DIR/skills" ] || PLUGIN_DIR="$HOME/.claude/plugins/marketplaces/navigator-marketplace"
python3 "$PLUGIN_DIR/skills/nav-sync-claude/functions/claude_updater.py" extract CLAUDE.md > /tmp/nav-customizations.json

This records the file's layout verbatim, with fenced code blocks kept whole (a # comment inside a bash block is not a header):

  • title: the first # header as written; project_name is the part before - Claude Code Configuration when the title has that shape, else the whole title
  • preamble: the text between the title and the first ## header
  • sections: every ## section in order, {"header", "body"}, bodies byte for byte (### subsections, fences and --- rules included)
  • navigator_section: the section Navigator owns — ## Navigator when present, else the section whose body carries the **Navigator runtime** paragraph; empty when none
  • has_context: whether a ## Context section exists
  • source_dir: the directory CLAUDE.md was read from (the project root for the liveness guard)

The flat lists stay for readers of the JSON and for hand-written customizations without a sections layout: description, core_principle and tech_stack (from Context), code_standards and forbidden_actions (every bullet, template defaults included; a default the project removed stays removed), pm_tool, and custom_sections with custom_section_anchors (every ## header the lists do not render, with the standard section each one precedes).

Step 4: Generate Updated CLAUDE.md

Apply latest template with extracted customizations:

PLUGIN_DIR="${CLAUDE_PLUGIN_ROOT:-$(cat "${NAVIGATOR_CONFIG_HOME:-${XDG_CONFIG_HOME:-$HOME/.config}/navigator}/plugin-root" 2>/dev/null)}"
[ -d "$PLUGIN_DIR/skills" ] || PLUGIN_DIR="$HOME/.claude/plugins/marketplaces/navigator-marketplace"
# Template fetching now automatic via get_template_path():
# 1. Tries GitHub (version-matched)
# 2. Falls back to bundled if offline
python3 "$PLUGIN_DIR/skills/nav-sync-claude/functions/claude_updater.py" generate \
  --customizations /tmp/nav-customizations.json \
  --template "$PLUGIN_DIR/templates/CLAUDE.md" \
  --output CLAUDE.md

Generate stamps **Last Updated** with today's date and **Navigator Version** with the installed plugin version (--stamp-date / --stamp-version override them). A dry run writes anywhere: --output /tmp/CLAUDE.preview.md. The hook-liveness guard checks the project root, never the output directory: --project-root DIR, else the source_dir that extract recorded, else the current directory. It exits 3 and leaves CLAUDE.md untouched when .agent/.nav-runtime-state.json is absent or older than 7 days.

Template Source Priority:

  1. GitHub (version-matched): Fetches from https://raw.githubusercontent.com/qf-studio/navigator/v{version}/templates/CLAUDE.md
    • Matches installed plugin version (e.g., v4.3.0)
    • Always up-to-date with release
    • Works with pre-releases
  2. Bundled (fallback): Uses templates/CLAUDE.md from installed plugin
    • Offline fallback
    • Guaranteed availability

What this does:

  1. Loads template (GitHub or bundled)
  2. Replaces placeholders with extracted data
  3. Preserves custom sections
  4. Updates Navigator workflow to natural language
  5. Removes slash command references
  6. Adds skills explanation

Step 5: Show Diff and Confirm

Display changes for user review:

echo ""
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "📝 CHANGES TO CLAUDE.MD"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""

# Show unified diff
diff -u CLAUDE.md.backup CLAUDE.md || true

echo ""
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"

Step 6: Verify and Commit

Show summary of changes:

✅ CLAUDE.md Updated to v3.1

Key changes:
  ✓ Removed slash command references (e.g., /nav:start)
  ✓ Added natural language examples ("Start my Navigator session")
  ✓ Added skills architecture explanation
  ✓ Updated Navigator workflow section
  ✓ Preserved your project-specific customizations:
    - Tech stack: [list]
    - Code standards: [count] custom rules
    - Forbidden actions: [count] custom rules

Backup saved: CLAUDE.md.backup

Next steps:
  1. Review changes: git diff CLAUDE.md
  2. Test: "Start my Navigator session" should work
  3. Commit: git add CLAUDE.md && git commit -m "chore: update CLAUDE.md to Navigator v3.1"
  4. Remove backup: rm CLAUDE.md.backup

Rollback if needed: mv CLAUDE.md.backup CLAUDE.md

Step 7: Update .nav-config.json

If config exists, migrate to latest version with new sections:

PLUGIN_DIR="${CLAUDE_PLUGIN_ROOT:-$(cat "${NAVIGATOR_CONFIG_HOME:-${XDG_CONFIG_HOME:-$HOME/.config}/navigator}/plugin-root" 2>/dev/null)}"
[ -d "$PLUGIN_DIR/skills" ] || PLUGIN_DIR="$HOME/.claude/plugins/marketplaces/navigator-marketplace"
if [ -f ".agent/.nav-config.json" ]; then
  python3 "$PLUGIN_DIR/skills/nav-sync-claude/functions/config_migrator.py" .agent/.nav-config.json
fi

What this does:

  1. Detects current config version
  2. Adds missing sections based on version:
    • v5.4.0+: simplification config
    • v5.5.0+: auto_update config
    • v5.6.0+: task_mode config
  3. Updates version marker to current

Example output:

✅ Config migrated: v5.4.0 → v5.6.0

Changes:
  + auto_update: (new section added)
  + task_mode: (new section added)
  ~ version: 5.4.0 → 5.6.0

Dry run (preview changes without applying):

PLUGIN_DIR="${CLAUDE_PLUGIN_ROOT:-$(cat "${NAVIGATOR_CONFIG_HOME:-${XDG_CONFIG_HOME:-$HOME/.config}/navigator}/plugin-root" 2>/dev/null)}"
[ -d "$PLUGIN_DIR/skills" ] || PLUGIN_DIR="$HOME/.claude/plugins/marketplaces/navigator-marketplace"
python3 "$PLUGIN_DIR/skills/nav-sync-claude/functions/config_migrator.py" .agent/.nav-config.json --dry-run

Predefined Functions

functions/version_detector.py

Purpose: Detect CLAUDE.md version (outdated, current, unknown)

Usage:

python3 version_detector.py CLAUDE.md

Output: Prints one of: outdated, current, unknown

Exit codes:

  • 0: Success (version detected)
  • 1: File not found
  • 2: Parse error

Detection logic:

  1. Check for version marker: Navigator Version: X.X.X
  2. Check for slash commands: /nav:start, /jitd:, etc.
  3. Check for natural language examples: "Start my Navigator session"
  4. Check for skills section

Heuristics:

  • Has /nav: → outdated
  • Version < 3.0 → outdated
  • Version >= 3.0 + natural language → current
  • No version + no Navigator markers → unknown

functions/claude_updater.py

Purpose: Extract customizations and generate updated CLAUDE.md

Usage:

# Extract customizations
python3 claude_updater.py extract CLAUDE.md > customizations.json

# Generate updated file
python3 claude_updater.py generate \
  --customizations customizations.json \
  --template ../../templates/CLAUDE.md \
  --output CLAUDE.md

Extract mode outputs JSON:

{
  "project_name": "MyApp",
  "title": "MyApp - Claude Code Configuration",
  "description": "Brief project description",
  "tech_stack": ["Next.js", "TypeScript", "PostgreSQL"],
  "core_principle": "API-first design with type safety",
  "code_standards": ["**Architecture**: KISS, DRY, SOLID principles", "Custom rule 1"],
  "forbidden_actions": ["No Claude Code mentions in commits/code", "Custom restriction 1"],
  "violations_marker": false,
  "pm_tool": "github",
  "custom_sections": {
    "Deployment": "Custom deployment instructions..."
  },
  "custom_section_anchors": {
    "Deployment": "Forbidden Actions"
  },
  "has_context": true,
  "preamble": "",
  "sections": [
    {"header": "Context", "body": "Brief project description\n\n**Tech Stack**: ..."},
    {"header": "Navigator", "body": "**Navigator runtime**: ..."},
    {"header": "Deployment", "body": "Custom deployment instructions..."},
    {"header": "Forbidden Actions", "body": "- ❌ No Claude Code mentions in commits/code"}
  ],
  "navigator_section": "Navigator",
  "source_dir": "/path/to/project"
}

Generate mode with a sections layout (what extract records): the project's own title, preamble and sections come back in their own order, bodies byte for byte, and only Navigator-owned text changes. A round trip on an already-current file changes only the two stamp lines.

  1. Loads template
  2. Writes the title as recorded (a title without - Claude Code Configuration stays)
  3. Writes the preamble and every section in source order
  4. ## Navigator takes the template's body; a section that carries the **Navigator runtime** paragraph under another name (## Navigator Integration) keeps its header and every other line and gets the template's paragraph in place
  5. Adds a template section the project lacks after the template section that precedes it: ## Context only as the two stamp lines when the file has no stamps anywhere (no description or tech-stack placeholders), ## Navigator only when no section carries the runtime paragraph, the standards and forbidden sections with the template's defaults (## Code Standards counts as the standards section)
  6. Stamps **Last Updated** (today) and **Navigator Version** (installed plugin) wherever the file keeps them

Generate mode without a sections layout (hand-written JSON): the template's structure around the flat lists, as before.

  1. Replaces [Project Name] with project_name
  2. Replaces [Brief project description] with description (line breaks kept)
  3. Replaces [List your technologies...] with tech_stack
  4. Replaces the **Core Principle** placeholder with core_principle (multi-line)
  5. Replaces the template's code-standards list and its [Customize ...] placeholder with code_standards (an empty list keeps the template's)
  6. Replaces the template's forbidden-actions list with forbidden_actions; the [Add project-specific violations here] marker stays only when the project had it
  7. Inserts each custom section before its anchor section (end of file without one)
  8. Stamps the two lines as above

functions/config_migrator.py

Purpose: Migrate .nav-config.json to latest version, adding missing sections

Usage:

# Migrate config (applies changes)
python3 config_migrator.py .agent/.nav-config.json

# Preview changes without applying
python3 config_migrator.py .agent/.nav-config.json --dry-run

# JSON output
python3 config_migrator.py .agent/.nav-config.json --json

Version-specific configs added:

  • v5.4.0: simplification (code clarity improvements)
  • v5.5.0: auto_update (session-start update notice; v8: never updates from a hook)
  • v5.6.0: task_mode (unified workflow orchestration)

Output example:

✅ Config migrated: v5.4.0 → v5.6.0

Changes:
  + auto_update: (new section added)
  + task_mode: (new section added)
  ~ version: 5.4.0 → 5.6.0

Exit codes:

  • 0: Success (config migrated or already current)
  • 1: Error (file not found, invalid JSON)

Error Handling

No CLAUDE.md found:

❌ No CLAUDE.md found in current directory

This project doesn't appear to have Navigator initialized.
Run "Initialize Navigator in this project" first.

Backup failed:

❌ Failed to create backup: CLAUDE.md.backup

Check file permissions and disk space.

Parse error:

❌ Failed to parse CLAUDE.md

The file might be corrupted or have unusual formatting.
Manual review required.

Backup saved at: CLAUDE.md.backup

Template not found:

❌ Navigator template not found

This might be a plugin installation issue.
Try reinstalling Navigator plugin: /plugin update navigator

Success Criteria

Migration is successful when:

  • CLAUDE.md backed up successfully
  • Version detected correctly
  • Customizations extracted
  • New file generated with v3.1 template
  • Project-specific content preserved
  • Diff shown to user for review
  • Commit instructions provided

Rollback Procedure

If migration fails or user is unhappy:

# Restore backup
mv CLAUDE.md.backup CLAUDE.md

# Or compare and manually fix
diff CLAUDE.md.backup CLAUDE.md

Notes

This skill:

  • Preserves all customizations (tech stack, standards, restrictions)
  • Non-destructive (always creates backup)
  • Idempotent (running multiple times is safe)
  • Transparent (shows diff before finalizing)

What gets updated:

  • Navigator version marker
  • Slash commands → natural language
  • Workflow examples
  • Skills vs commands explanation
  • Token optimization strategy

What gets preserved:

  • Project name and description
  • Tech stack
  • Code standards
  • Forbidden actions
  • PM tool configuration
  • Custom sections

Related Skills

  • nav-init: Initialize Navigator in new project (creates CLAUDE.md from scratch)
  • nav-start: Start session (uses updated CLAUDE.md)
  • nav-task: Task documentation (benefits from updated workflow)

Examples

Example 1: Simple Update

User: "Update my CLAUDE.md to v3.1"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.