| name | project-map |
| description | Use the durable project map at .agents/PROJECT_MAP.md before exploring a codebase. Generate or refresh with agentsctl map generate. Prefer the map plus targeted reads over recursive full-tree walks.
|
Project map skill
When to use
At the start of work in a workspace (or after large structural changes), orient
from the project map instead of re-walking the entire tree.
Steps
- Check for
.agents/PROJECT_MAP.md in the workspace root (cwd).
- If missing or clearly stale:
- Prefer:
agentsctl map generate -r <cwd> (when agentsd is available)
- Or tell the user to regenerate, then continue with minimal exploration
- Read
.agents/PROJECT_MAP.md (and optionally .agents/project_map.json).
- Use Read these first and Layout to open only the files you need.
- After major moves/renames/new packages: regenerate the map.
Staleness
.agents/map_meta.json records git_head and generated_at.
- If current
git rev-parse HEAD â git_head â regenerate
- If older than ~14 days â regenerate
agentsctl map status -r <cwd> reports stale + reason
Context manager (preferred)
One shot refresh of map + packed CONTEXT.md + memory index:
agentsctl context ensure -r .
agentsctl context status -r .
Session start auto-runs ensure when context.ensure_on_session = true (default).
Optional: memory search
After reading the map / CONTEXT.md, for topic-specific docs:
agentsctl memory search -r . "relevant terms"
Index first (once per workspace, or after big doc changes):
agentsctl memory index -r .
Do not
- Dump entire monorepos into context when a map exists
- Ignore
AGENTS.md / CLAUDE.md / README listed under âRead these firstâ
- Treat the map as authoritative for line-level code â still open real files
One-liner for project instructions
## Project map
Read `.agents/PROJECT_MAP.md` before exploring. Regenerate: `agentsctl map generate`.