mirror of
https://github.com/awizemann/scarf.git
synced 2026-05-10 10:36:35 +00:00
Alan Wizemann
d8a0a89db2
Set up the catalog directory structure this branch will fill with community templates. The existing site-status-checker example moves from examples/templates/ to templates/awizemann/site-status-checker/ (tracked by git as a rename so history is preserved). The examples/ directory is removed. New top-level docs: - templates/README.md — landing for folks browsing the catalog on github.com. Lists the current templates and points at the live site. - templates/CONTRIBUTING.md — author-facing submission walkthrough. Requires AGENTS.md, pre-flight with tools/build-catalog.py --check (added in the next commit), one template per PR, don't edit catalog.json (maintainer regenerates it post-merge). ProjectTemplateExampleTemplateTests.locateExample updated to search templates/<author>/<name>/ instead of examples/templates/ — the test still walks up from #filePath to find the repo root so it works in both xcodebuild and Xcode IDE test runs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
53 lines
2.9 KiB
Markdown
53 lines
2.9 KiB
Markdown
# Scarf Templates
|
|
|
|
The community template catalog for [Scarf](https://github.com/awizemann/scarf) — a macOS GUI for the Hermes AI agent. Each subdirectory here is one installable project template. Browse the live catalog with live dashboard previews at **<https://awizemann.github.io/scarf/templates/>**.
|
|
|
|
## What's a template?
|
|
|
|
A `.scarftemplate` bundle ships:
|
|
|
|
- A pre-configured project **dashboard** (widgets for stats, lists, text, charts).
|
|
- A cross-agent **`AGENTS.md`** ([agents.md standard](https://agents.md/)) that tells Claude Code, Cursor, Codex, Aider, Jules, Copilot, Zed, etc. how to work with the project.
|
|
- Optional **skills**, **cron jobs**, optional per-agent instruction shims (`CLAUDE.md`, `GEMINI.md`, `.cursorrules`, `.github/copilot-instructions.md`), and an optional **memory appendix**.
|
|
|
|
Users install with one click from the catalog site or by opening a `.scarftemplate` file in Scarf.
|
|
|
|
## Layout
|
|
|
|
Each template lives at `templates/<github-handle>/<template-name>/` with:
|
|
|
|
```
|
|
templates/<github-handle>/<template-name>/
|
|
├── staging/ source tree
|
|
│ ├── template.json manifest (id, name, version, contents claim)
|
|
│ ├── README.md shown on catalog detail page
|
|
│ ├── AGENTS.md required cross-agent instructions
|
|
│ ├── dashboard.json rendered as a live preview on the catalog site
|
|
│ ├── instructions/… optional per-agent shims
|
|
│ ├── skills/… optional namespaced skills
|
|
│ ├── cron/jobs.json optional cron job definitions
|
|
│ └── memory/append.md optional memory appendix
|
|
├── <template-name>.scarftemplate built bundle (zipped staging/), committed as-is
|
|
└── screenshots/ optional PNGs for the detail page
|
|
```
|
|
|
|
The built `.scarftemplate` is served directly from `raw.githubusercontent.com` — the catalog's Install button links at:
|
|
|
|
```
|
|
scarf://install?url=https://raw.githubusercontent.com/awizemann/scarf/main/templates/<author>/<name>/<name>.scarftemplate
|
|
```
|
|
|
|
## Contributing a template
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full submission walkthrough. tl;dr: fork, drop a template under `templates/<your-handle>/<your-name>/`, open a PR. A CI check validates the bundle; a maintainer reviews the content.
|
|
|
|
## Catalog metadata
|
|
|
|
`catalog.json` at this directory is the aggregate index that the website reads. It's regenerated by the maintainer on merge — **do not modify it in your PR**, the build script will take care of it.
|
|
|
|
## Current templates
|
|
|
|
| Template | Author | Description |
|
|
|---|---|---|
|
|
| [site-status-checker](awizemann/site-status-checker/) | awizemann | Daily HTTP uptime check for a user-editable list of URLs. Dashboard + cron + AGENTS.md. |
|