Commands

Commands

Complete CLI reference for agent-notes.

Global Options

Flag	Description
-v, --version	Show version

---

install

Build and install components via interactive wizard.

agent-notes install [--local] [--copy] [--reconfigure]

Flag	Description
--local	Install to current project only
--copy	Copy files instead of symlink (with --local)
--reconfigure	Clear existing state and re-run the wizard

Default behavior (no flags): runs the interactive wizard for global installation.

---

uninstall

Remove installed components.

agent-notes uninstall [--local] [--global]

Flag	Description
--local	Remove from current project only
--global	Remove from global scope only
(no flags)	Remove from both scopes

---

doctor

Check installation health.

agent-notes doctor [--local] [--fix]

Flag	Description
--local	Check local installation
--fix	Auto-fix found issues

---

info

Show installation status, component counts, and storage info.

agent-notes info

No flags. Displays version, installed components, storage type, and install targets.

---

list

List installed components.

agent-notes list [filter]

Argument	Values	Default
filter	agents, skills, rules, clis, models, roles, all	all

---

validate

Lint source configuration files for errors.

agent-notes validate

No flags. Checks YAML, markdown, and frontmatter in agent/skill/rule source files.

---

set role

Set role-to-model assignment.

agent-notes set role <role_name> <model_id> [--cli <name>] [--scope <scope>] [--local]

Argument/Flag	Description
role_name	Role to configure (reasoner, worker, scout, orchestrator)
model_id	Model ID (e.g., claude-opus-4-7, claude-sonnet-4-6)
--cli <name>	Target CLI (auto-detect if omitted)
--scope <global|local>	Install scope
--local	Shorthand for --scope local

---

regenerate

Rebuild installed files from current state.

agent-notes regenerate [--scope <scope>] [--cli <name>] [--local]

Flag	Description
--scope <global|local>	Install scope
--cli <name>	Regenerate specific CLI only
--local	Shorthand for --scope local

---

build

Build agent configuration files from source. Used during development.

agent-notes build

No flags.

---

memory

Manage agent memory. See Memory-Storage for detailed mode documentation.

agent-notes memory [action] [name] [extra...]

Default action: list.

Memory actions

Action	Arguments	Description
init	—	Create folder structure and Index.md
list	—	List all notes by category/agent (default)
vault	—	Show current storage type, path, and init status
index	—	Regenerate Index.md
add	title, body, [type], [agent], [project]	Add a note
size	—	Show total disk usage
show	name	Show one agent's or category's notes
reset	[name]	Clear all memory or one agent's (requires confirmation)
export	—	Back up to memory-backup/
import	—	Restore from memory-backup/
migrate	—	Migrate vault layout
ingest	title, summary, [concepts], [entities], [tags]	Ingest source material (Wiki mode only; use /ingest skill for Obsidian mode)
query	keyword	Search wiki pages (wiki only)
lint	—	Check wiki health (wiki only)

Note types for add

Type	Description
pattern	Reusable solution or technique
decision	Architectural choice with rationale
mistake	Recurring error to avoid
context	Project background, constraints
session	Current session's running log (appends to existing)

Ingest (no args)

When called with no arguments, memory ingest scans the raw/ directory for unprocessed files and reports what can be ingested:

agent-notes memory ingest    # scan for unprocessed raw files

Mode note: The memory ingest CLI command is available in Wiki mode only. For Obsidian mode (both session and knowledge wiki variants), use the /ingest skill instead, which routes through agent-notes memory add. See Memory-Storage for detailed mode documentation and ingest pipeline differences.

---

cost-report

Report token usage and cost for the current AI session. See Cost-Report for detailed documentation.

agent-notes cost-report [--since <datetime>] [--session <id>]

Flag	Description
--since <ISO-datetime>	Only include messages at or after this UTC datetime
--session <id>	Report on a specific session (Claude Code only)

---

config

Reconfigure settings after install.

agent-notes config [action] [extra...] [--cli <name>]

Default action: wizard.

Config actions

Action	Arguments	Description
wizard	—	Interactive configuration wizard (default)
show	—	Print current configuration
role-model	role, model	Set role-to-model mapping (scriptable)
role-agent	role, agent	Show agent info for a role
providers	—	Interactive API key entry for providers
provider	name	Check if a provider is configured (scriptable)

Flag	Description
--cli <name>	Target CLI: claude, opencode, or both