Setup Codemap Cli
Install and wire Codemap CLI into Claude Code via CLAUDE.md and hook settings so agents can navigate unfamiliar codebases visually.
Overview
Setup Codemap CLI is an agent skill most often used in Build (also Operate infra) that installs Codemap and configures Claude Code CLAUDE.md and hook settings for codebase visualization.
Install
npx skills add https://github.com/neolabhq/context-engineering-kit --skill setup-codemap-cliWhat is this skill?
- Chooses project-shared, project-local, or global `~/.claude` configuration paths
- Verifies install with `codemap -help` before documenting hooks
- Loads upstream Codemap README from GitHub for capability-accurate setup steps
- Writes CLAUDE.md or CLAUDE.local.md plus `.claude/settings.json` hook entries
- Ensures local-only config files are listed in `.gitignore` when using personal prefs
- 3 explicit configuration scopes: project git-shared, project local, and user global
Adoption & trust: 513 installs on skills.sh; 1.1k GitHub stars; 0/3 security scanners passed (skills.sh audits).
What problem does it solve?
Your agent keeps searching blind in a large repo because Codemap is not installed or Claude hooks never point at it.
Who is it for?
Indie devs joining unfamiliar repos who want one guided pass to connect Codemap with Claude Code at project or global level.
Skip if: Teams that already standardized Codemap in CI or who do not use Claude Code CLAUDE.md hook patterns.
When should I use this skill?
User wants to install or configure Codemap CLI for Claude Code visualization and navigation, optionally with OS or preference hints.
What do I get? / Deliverables
Codemap is installed and Claude Code settings reference it at the chosen scope so sessions can use map-based navigation consistently.
- Updated CLAUDE.md, CLAUDE.local.md, or ~/.claude/CLAUDE.md Codemap section
- Hook entries in matching `.claude/settings.json` or settings.local.json
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Primary shelf is Build agent-tooling because setup targets Claude/Codemap integration; the same config pays off in Operate when debugging legacy repos. Agent-tooling fits CLAUDE.md and `.claude/settings` hook configuration rather than shipping app features.
Where it fits
Wire Codemap into a fresh clone so the coding agent can orient before editing unfamiliar modules.
Document team-shared CLAUDE.md instructions that tell everyone to launch Codemap for onboarding walkthroughs.
Restore personal `~/.claude` Codemap hooks after migrating laptops without breaking project-local gitignored overrides.
How it compares
One-time CLI + Claude hook wiring—not an in-editor theme or a static architecture Markdown doc alone.
Common Questions / FAQ
Who is setup-codemap-cli for?
Solo builders and small teams using Claude Code who want Codemap for visual codebase navigation without reading scattered install docs.
When should I use setup-codemap-cli?
During Build → agent-tooling when onboarding a repo; during Operate → infra when revisiting agent hooks after an OS reinstall; during Build → docs when documenting how newcomers should explore the tree.
Is setup-codemap-cli safe to install?
Use the Security Audits panel on this Prism page for the kit source; setup may fetch remote README content and edit local Claude settings—review paths before applying on sensitive repos.
SKILL.md
READMESKILL.md - Setup Codemap Cli
User Input: ```text $ARGUMENTS ``` # Guide for setup Codemap CLI ## 1. Determine setup context Ask the user where they want to store the configuration: **Options:** 1. **Project level (shared via git)** - Configuration tracked in version control, shared with team - CLAUDE.md updates go to: `./CLAUDE.md` - Hook settings go to: `./.claude/settings.json` 2. **Project level (personal preferences)** - Configuration stays local, not tracked in git - CLAUDE.md updates go to: `./CLAUDE.local.md` - Hook settings go to: `./.claude/settings.local.json` - Verify these files are listed in `.gitignore`, add them if not 3. **User level (global)** - Configuration applies to all projects for this user - CLAUDE.md updates go to: `~/.claude/CLAUDE.md` - Hook settings go to: `~/.claude/settings.json` Store the user's choice and use the appropriate paths in subsequent steps. ## 2. Check if Codemap is already installed Check whether codemap is installed by running `codemap -help`. If not installed, proceed with setup. ## 3. Load Codemap documentation Read the following documentation to understand Codemap's capabilities: - Load <https://raw.githubusercontent.com/JordanCoin/codemap/refs/heads/main/README.md> to understand what Codemap is and its capabilities ## 4. Guide user through installation ### macOS/Linux (Homebrew) ```bash brew tap JordanCoin/tap && brew install codemap ``` ### Windows (Scoop) ```bash scoop bucket add codemap https://github.com/JordanCoin/scoop-codemap scoop install codemap ``` ## 5. Verify installation After installation, verify codemap works: ```bash codemap . ``` ## 6. Update CLAUDE.md file Use the path determined in step 1. Once Codemap is successfully installed, update the appropriate CLAUDE.md file with the following content: ```markdown ## Use Codemap CLI for Codebase Navigation Codemap CLI is available for intelligent codebase visualization and navigation. **Required Usage** - You MUST use `codemap --diff --ref master` to research changes different from default branch, and `git diff` + `git status` to research current working state. ### Quick Start ```bash codemap . # Project tree codemap --only swift . # Just Swift files codemap --exclude .xcassets,Fonts,.png . # Hide assets codemap --depth 2 . # Limit depth codemap --diff # What changed vs main codemap --deps . # Dependency flow ``` ### Options | Flag | Description | |------|-------------| | `--depth, -d <n>` | Limit tree depth (0 = unlimited) | | `--only <exts>` | Only show files with these extensions | | `--exclude <patterns>` | Exclude files matching patterns | | `--diff` | Show files changed vs main branch | | `--ref <branch>` | Branch to compare against (with --diff) | | `--deps` | Dependency flow mode | | `--importers <file>` | Check who imports a file | | `--skyline` | City skyline visualization | | `--json` | Output JSON | **Smart pattern matching** - no quotes needed: - `.png` - any `.png` file - `Fonts` - any `/Fonts/` directory - `*Test*` - glob pattern ### Diff Mode See what you're working on: ```bash codemap --diff codemap --diff --ref develop ``` ``` if the default branch is not `main`, but instead `master` (or something else) update content accordingly: - use `codemap --diff --ref master` instead of regular `codemap --diff` ## 7. Update .gitignore file Update .gitignore file to include `.codemap/` directory: ```text .codemap/ ``` ## 8. Test Codemap Run a quick test to verify everything works: ```bash codemap . codemap --diff ``` ## 9. Add hooks to settings file - Use the settings path determined in step 1. Create the settings file if it doesn't exist and add the following content: ```json { "hooks": {