mirror of https://github.com/awizemann/scarf.git synced 2026-05-10 02:26:37 +00:00

Files

T

Alan Wizemann 38c075d61d docs: ship site-status-checker example template + v2.2.0 release notes

First installable template demonstrating the format:
- Dashboard with stat widgets (up/down/last-checked) + configured-sites
  list + quick-start markdown.
- Cross-agent AGENTS.md with the full cron-prompt contract so any agent
  that reads agents.md (Claude Code, Cursor, Codex, Aider, Jules,
  Copilot, Zed, …) picks up the behavior on first run.
- Cron job (0 9 * * *) that ships paused with the [tmpl:…] tag, pinging
  a user-editable sites.txt and writing results to status-log.md.
- First-run bootstrap logic in AGENTS.md: if sites.txt doesn't exist
  yet the agent creates it with two placeholder URLs, then proceeds.

Plus examples/templates/README.md explaining the staging/ layout,
authoring conventions, and how to rebuild a bundle after editing. CI
validates the bundle via ProjectTemplateExampleTemplateTests so drift
between staging/ and the built .scarftemplate fails on every build.

v2.2.0 release notes cover the full feature surface including the
install preview sheet, scarf:// + file:// URL handling, skills
namespacing, cron-job tagging, memory-block markers, and the
lock-driven uninstall flow.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-04-23 00:35:46 +02:00

site-status-checker

docs: ship site-status-checker example template + v2.2.0 release notes

2026-04-23 00:35:46 +02:00

README.md

docs: ship site-status-checker example template + v2.2.0 release notes

2026-04-23 00:35:46 +02:00

README.md

Example Templates

This directory holds reference .scarftemplate bundles shipped in the Scarf repo. Each subdirectory is one template, laid out as:

<template-name>/
├── staging/                          Source tree — the exact layout of the bundle
│   ├── template.json
│   ├── README.md
│   ├── AGENTS.md
│   ├── dashboard.json
│   ├── cron/jobs.json                (optional)
│   ├── skills/<name>/…               (optional)
│   ├── instructions/…                (optional)
│   └── memory/append.md              (optional)
└── <template-name>.scarftemplate     Built bundle (zipped staging dir)

Available templates

site-status-checker — daily HTTP uptime check for a user-editable list of URLs. Dashboard + cron + AGENTS.md. The simplest example that exercises the full format.

Rebuilding a bundle after editing

cd <template-name>/staging
zip -qq -r ../<template-name>.scarftemplate .

The Scarf test suite (ProjectTemplateExampleTemplateTests) validates each shipped .scarftemplate on every build, so a bundle that fails to round-trip through inspect → buildPlan will fail CI.

Authoring conventions

Always ship AGENTS.md. It's the Linux Foundation cross-agent standard (agents.md) and every supported agent reads it. Agent-specific shims (CLAUDE.md, GEMINI.md, .cursorrules, .github/copilot-instructions.md) go under instructions/ and only when there's a real per-agent behavior the author needs.
Cron jobs ship paused. Don't assume the user wants your job running on install. Write the prompt so running it manually from chat ("run the X job") also works — the cron is just a schedule wrapper.
Dashboard values that change at runtime should be placeholders. The agent (not the installer) keeps them fresh. Start with sensible zeros / "never" / "unknown" so an uninstalled, inactive project still renders cleanly.
Don't claim in the manifest what you don't ship. The contents block is cross-checked against the unpacked files — a mismatch makes the installer refuse the bundle.