notes-cli
Skill2 starsChanged 20 days agoApache-2.0View on GitHub
Use the notes CLI to find, read, create, update, and delete repository notes. Use for shell-based note workflows, notes commands, and handoff storage. For Notes MCP tool calls, use notes-mcp instead.
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 10
Use the notes CLI for vault access.
- Distinctive: line 12
Use the CLI when a note command, skill, or explicit user request calls for a note operation.
- Very specific: line 20
Read a selected note with notes read --path "<absolute-path>" --json.
- Very specific: line 21
Create or replace a note by passing its complete Markdown content on stdin to notes write --path "<absolute-path>" --stdin --json:
- Very specific: line 24
Before deletion, name the note and obtain explicit confirmation.
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 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.
Files
Notes CLI
Use the notes CLI for vault access. Run it from the target repository so context and listings resolve the right scope. Check a subcommand's --help when its flags are uncertain.
Use the CLI when a note command, skill, or explicit user request calls for a note operation. Tool availability alone does not authorise note mutations.
Note bodies are free-form Markdown written mostly for later agent reading. A few paragraphs with no headings is a valid note; keep name, description, and tags useful because listings rely on them.
Workflow
- Resolve the absolute note directory from injected repository-note context or
notes context --command <command> --json. The--commandflag is required; use the active note command, ornotes-listfor discovery. Use the returnednotesPath, including a resolved local scope, rather than constructing a vault path from owner and repository names. If no usable note path is returned, report that failure before writing. - Find notes with
notes list --format json, optionally filtered by--tag. Use--allonly for an explicit cross-repository request. - Read a selected note with
notes read --path "<absolute-path>" --json. Keep both its full content and revision hash for an update. - Create or replace a note by passing its complete Markdown content on stdin to
notes write --path "<absolute-path>" --stdin --json:- For creation, verify the target is unused.
writeis not create-only; stop rather than overwrite an uncertain target. Include valid YAML frontmatter and body, and let the CLI set the date. - For updates, preserve unrelated frontmatter and content, and add
--expected-hash "<revision-from-read>". On a stale revision, read again and reconcile before retrying. Never omit the hash to bypass a conflict.
- For creation, verify the target is unused.
- Before deletion, name the note and obtain explicit confirmation. Then run
notes delete --path "<absolute-path>" --json. - Report the returned mutation result. The CLI handles timestamps, Git commits, and pushes; a local save can succeed while persistence to Git or the remote fails. Surface partial failures instead of repeating the mutation blindly.
Trust a successful JSON result. Do not read the note back or run separate date, commit, status, or push commands just to confirm it. Use CLI operations rather than direct filesystem access to the vault.
In this repository15 other files it gives its agents.
- AGENTS.mdAGENTS.md
- changeset-scopeSkill
- code-reviewSkill
- docs-kitSkill
- effect-ghSkill
- effect-herdrSkill
- effect-service-designSkill
- effectSkill
- notes-mcpSkill
- opentuiSkill
- skill-prefixesSkill
- task-runnersSkill
- testingSkill
- types-enforce-tsSkill
- writing-styleSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.

