daybook/skills/daybook-posting/SKILL.md
peter 532b4bd4eb Document #009's substring-check limitation; fix #011's CDN docs and theme typo
#009: html_fragment's content-shape check is substring-based, so it can
false-positive on inert text inside <script>/<pre> (e.g. a JS string
literal that happens to contain "<html>"). Documented as a known
limitation in docs/api.md rather than implementing real HTML parsing - a
proper fix is a much bigger change than the narrow trigger justifies, and
substring matching is the same approach the client helper already uses.

#011: added a curated CDN Snippets section to SKILL.md for html_full
(Tailwind, Chart.js, with an offline/air-gapped caveat), scoped explicitly
to that kind only. Fixed daybook_post.py's --theme help text, which named
a non-existent "bootstrap" theme (written ahead of a vendored-Bootstrap
feature that was planned but never built, not a typo).

Also updated SKILL.md's kind cheat sheet, which never mentioned the
json/csv kinds and still pointed at the old --as-markdown workaround for
them - and filed issue #012 for a real gap that surfaced doing so: the
posting script itself doesn't support --kind json/csv yet, only the raw API
does.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-02 15:32:22 +01:00

4.8 KiB

name description
daybook-posting Use when you have produced a finished deliverable such as a report, summary, brief, diagram, generated HTML, PDF, deck, or status update that a human should review later outside this chat. Publishes the artifact to Daybook and returns a URL.

Daybook Posting

Daybook is a private artifact journal for completed agent outputs. It stores, indexes, and displays artifacts for human review. It does not execute commands, run workflows, or continue conversations.

Always use the helper script. Do not hand-build curl, JSON, PowerShell multipart, or inline shell content.

From the project root:

python skills/daybook-posting/scripts/daybook_post.py --check
python skills/daybook-posting/scripts/daybook_post.py --kind markdown --title "Build Report" --content-file report.md
cat report.md | python skills/daybook-posting/scripts/daybook_post.py --kind markdown --title "Build Report"
python skills/daybook-posting/scripts/daybook_post.py --file diagram.svg --title "Architecture Diagram"

The project also keeps a compatibility wrapper at scripts/daybook_post.py, but the canonical helper is bundled inside this skill.

The artifact URL is printed as the final stdout line.

Configuration

Set these as real process/shell environment variables (export on Linux/macOS, $env: or set on Windows, or your agent harness's own env config) — the helper reads os.environ directly. There is no .env file support; a .env file in the working directory is not read automatically.

DAYBOOK_URL=http://127.0.0.1:8001
DAYBOOK_TOKEN=your-personal-api-token
DAYBOOK_SOURCE=agent

DAYBOOK_TOKEN is your personal per-user API token, from Settings → Account in the app (not a token shared by everyone). Artifacts posted with your token land only in your feed.

Kind Cheat Sheet

Kind Use for Content shape
markdown Reports, briefs, notes Markdown text. Fenced code blocks get syntax highlighting.
html_fragment Themed HTML reports/cards/tables Body-only HTML. No html/head/body.
html_full Complete custom pages/frameworks Full HTML document with doctype/html/head/body. See "CDN Snippets" below.
deck Simple slide-like artifact Top-level <section>...</section> blocks.
json Structured data, metrics, run summaries Valid JSON text. Renders as a collapsible tree.
csv Tabular data CSV text, first row as header. Renders as a sortable/searchable table.

For images, PDFs, SVGs, and other files, use --file; the helper infers multipart and content type.

CDN Snippets For html_full

html_full is Daybook's escape hatch for custom pages — nothing is injected into it, so a poster wanting Tailwind or a charting library has to supply its own <link>/<script> tags. Known-good ones:

<!-- Tailwind (Play CDN - compiles in-browser on every load; fine for a
     one-off artifact, not something you'd want on a high-traffic page) -->
<script src="https://cdn.tailwindcss.com"></script>

<!-- Chart.js -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>

Offline caveat: Daybook can run fully self-hosted/air-gapped. Any artifact that links a CDN script won't render fully (or at all, for Tailwind's in-browser compiler) without internet access. If the deployment target is offline, don't reach for these — use markdown/html_fragment instead, which are styled entirely server-side with no external requests.

Only use this for html_full specifically — never add CDN references to markdown/html_fragment/deck. Those kinds exist so Daybook, not the poster, owns styling; injecting a default CDN habit into them would undermine that.

Images Inside Content

To embed an image within a markdown or HTML artifact (rather than posting it as its own artifact), upload it first and reference the returned URL:

# 1. Upload -> prints the URL as the last line
python skills/daybook-posting/scripts/daybook_post.py --upload-image chart.png

# 2. Reference that URL in your markdown, then post as usual
#    ![chart](http://127.0.0.1:8001/assets/ab12cd34ef56)
python skills/daybook-posting/scripts/daybook_post.py report.md

The image is linked to the artifact that references it and is deleted along with it. Unreferenced uploads are cleaned up after 24 hours.

For CSV, JSON, or code that should render today, use --file path --as-markdown to post it as a Markdown fenced code block. Without --as-markdown, these upload as downloadable binary files.

Rules

  • Run --check first if unsure Daybook is reachable.
  • Use a stable DAYBOOK_SOURCE or pass --source (the agent-profile, script, or person name that produced this artifact).
  • Use --tags a,b,c for filtering.
  • Use --meta run_id=... --meta model=... for machine-readable context.
  • Never inline multiline content into the shell command; use a file or stdin.