agentleFS
tkollehtkolleh/skills/save-zk/SKILL.md

save-zk

Skill1 starsChanged 3 months agoMITView on GitHub

Only when the user explicitly invokes `save-zk` or `/save-zk`. Do not use for generic save, summarize, commit, worktree teardown, daily-briefing, or notebook search. Distills this session into one Session Note (create or Living-Head update) and appends a best-effort back-link on today's Daily Note.

The file

We split this skill into the rules it gives an agent

11 rules. About 0 are common, 8 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run only on explicit invoke: save-zk or /save-zk.

    line 17
  2. Distinctive:

    Never invent or silently pick a key.

    line 29
  3. Distinctive:

    Done when: every candidate source is present or marked unavailable.

    line 47
  4. Distinctive:

    Prefer tag match on the issue key.

    line 53
  5. Distinctive:

    Done when: create vs update decided and target path known (or create path planned).

    line 63
  6. Distinctive:

    No asset files, no base64, no hard dependency on diagram/visualize CLIs.

    line 99
  7. Very specific:

    Create: prefer zk new into the single Session Note Location (key-agnostic.

    line 116
  8. Distinctive:

    Must not alter, delete, or reorder prior Updates or frozen create-time Deep Context.

    line 135
  9. Distinctive:

    Must not delete Session Note, Daily Note, or session sources.

    line 136
  10. Very specific:

    If unsure content already exists → append or mark <!-- possibly duplicate — review -->.

    line 137
  11. Distinctive:

    No worktree removal, git cleanup, tracker transitions, or other notebook edits.

    line 138

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

save-zk

Run only on explicit invoke: save-zk or /save-zk. No other phrases.

Phases A → I in order. Never skip or reorder. After Phase A, write immediately (no second confirm). Dry-run only if the user asked.

Load references on demand: references/note-template.md, references/living-head.md, references/session-context.md.


Phase A — Note Key gate

  1. Suggest candidates from branch name, open PR/issue, or session materials when present.
  2. Human supplies or confirms the Note Key (tracker id) or a ≤8-word slug.
  3. Never invent or silently pick a key. Stop until confirmed.

Done when: confirmed Note Key/slug in hand.


Phase B — Gather Session Context

This session only. Fan out reads in parallel when independent.

InOut
Session memories, touched markdown/allium, new/updated diagram fences or chartsWhole-repo docs crawl
Decisions stated in-sessionSecrets, tokens, credentials
Branch / PR / issue metadata when availableUnrelated history

Mark each source present or unavailable. Details: references/session-context.md.

Done when: every candidate source is present or marked unavailable.


Phase C — Note Lookup

Prefer tag match on the issue key; filename match is fallback.

HitsAction
0Create
1Update that note
>1Update most recently modified match — do not ask; do not merge files

Issue-key Note Keys must be (or become) frontmatter tags.

Done when: create vs update decided and target path known (or create path planned).


Phase D — Daily Note resolve

zk daily

Record Daily Note path, or mark unavailable (do not invent a path).

Done when: path known or explicitly unavailable.


Phase E — Distill

Compose per references/note-template.md + references/living-head.md.

  • Create: full Living Head + top-level Deep Context <details>. No Update section.
  • Update: replacement Living Head + one new ## Update: YYYY-MM-DD delta only. Do not rewrite prior Updates or frozen create-time Deep Context.
  • Concision: shortest form that still carries meaning. No Task Matrix section.

Done when: markdown body ready to write.


Phase F — Visual Section

Include in Living Head only when multi-component structure/flow or numeric metrics apply:

  1. Reuse d2 / mermaid fences already in Session Context.
  2. Else draft a minimal fence or metric table in-note.
  3. Omit or clear when N/A.

No asset files, no base64, no hard dependency on diagram/visualize CLIs.

Done when: Visual present, cleared, or omitted with reason N/A.


Phase G — Related Links

Best-effort real [[wikilinks]] from notebook search + link to today's Daily Note. Never invent titles. Omit non-daily related links if none.

Done when: links list final (may be Daily-only).


Phase H — Write

  1. Session Note (primary)
    • Create: prefer zk new into the single Session Note Location (key-agnostic; parameterize with Note Key). On zk new failure, write markdown under the notebook projects path and report fallback.
    • Update: replace only the Living Head; append the new Update at the bottom.
  2. Daily Note (best-effort): append one back-link line that the Session Note was created or updated. On Daily failure: keep Session Note, warn. On Session Note failure: skip Daily.

Done when: Session Note write attempted; Daily attempted if Session succeeded.


Phase I — Report

Paths written + BLUF + any Daily warning. If user asked dry-run, show composed markdown and paths only — no writes.

Done when: human sees report.


Safety contract

  1. May replace only the Living Head.
  2. Must not alter, delete, or reorder prior Updates or frozen create-time Deep Context.
  3. Must not delete Session Note, Daily Note, or session sources.
  4. If unsure content already exists → append or mark <!-- possibly duplicate — review -->.
  5. No worktree removal, git cleanup, tracker transitions, or other notebook edits.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.