Ship the agent skill in-repo and document installing it

The skill only existed on my machine, so nobody else could get it. It now
lives at skills/apple-notes/SKILL.md and the README covers installing it
alongside the CLI.

Adds an agent-driven install path: pointing an agent at the README is enough,
since it now carries a collapsed block of literal setup steps -- platform
check, CLI install with a pipx fallback, skill fetch, and a verification run --
plus what the two likely failures (no database, no permission) mean.

Drops the local-checkout path from the skill's install hint, which was only
valid on my machine.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
ingjieyeandClaude Opus 5 committed 2026-09-09 16:48:48 +08:00
1 parent 07bf3854b7
commit ad668fbcd3
2 files changed
+160

No files matched your search

+57
View File
@@ -80,6 +80,16 @@ create and edit notes. The two compose well — see
Requires macOS and Python 3.10+.
### Just ask your agent
If you use Claude Code, Claude Desktop, or any coding agent, point it at this
file and it has everything it needs:
> Read https://github.com/ingjieye/apple-notes-cli/blob/main/README.md and set
> it up, including the skill.
### The CLI
```bash
uv tool install git+https://github.com/ingjieye/apple-notes-cli
# or
@@ -96,6 +106,53 @@ uv run python -m apple_notes_cli recent
macOS may ask you to grant your terminal access to the Notes container the
first time. Nothing here needs Full Disk Access on its own.
### The agent skill
[`skills/apple-notes/SKILL.md`](skills/apple-notes/SKILL.md) teaches an agent
to use this CLI — when to reach for it, how to page from search results to full
note bodies, and what its limits are. Drop it in place:
```bash
mkdir -p ~/.claude/skills/apple-notes
curl -fsSL https://raw.githubusercontent.com/ingjieye/apple-notes-cli/main/skills/apple-notes/SKILL.md \
-o ~/.claude/skills/apple-notes/SKILL.md
```
Use `.claude/skills/` inside a project instead of `~/.claude/skills/` to scope
it to that project. Then ask your agent things like "what did I note about the
cluster migration?" or "找一下我记过的会议决定".
<details>
<summary>Setup steps, if you are an agent reading this</summary>
```bash
# 1. macOS only; bail out early elsewhere.
[ "$(uname)" = "Darwin" ] || { echo "macOS required"; exit 1; }
# 2. Install the CLI (uv preferred, pipx as fallback).
if command -v uv >/dev/null; then
uv tool install git+https://github.com/ingjieye/apple-notes-cli
else
pipx install git+https://github.com/ingjieye/apple-notes-cli
fi
# 3. Install the skill.
mkdir -p ~/.claude/skills/apple-notes
curl -fsSL https://raw.githubusercontent.com/ingjieye/apple-notes-cli/main/skills/apple-notes/SKILL.md \
-o ~/.claude/skills/apple-notes/SKILL.md
# 4. Verify against the real store. Exit 1 from `search` just means no match.
apple-notes folders | head -5
apple-notes recent -n 3
```
If step 4 reports the database is missing, Notes.app has never been launched on
this machine. If it raises a permission error, the terminal needs access to the
Notes container — that is a macOS prompt the user has to accept, not something
you can grant.
</details>
## Commands
```