agentleFS
robzolkosrobzolkos/LazyPi/AGENTS.md

LazyPi

AGENTS.md488 starsChanged 6 months agoMITView on GitHub

LazyPi is an opinionated installer for the Pi coding agent. It provides a curated catalog of Pi extensions, themes, skills, and workflow tools so users can run one command and get a complete Pi setup. The CLI is published to npm as @robzolkos/lazypi. The main executable is bin/lazypi.mjs, with package metadata and install behavior centered around the PACKAGES catalog in that file. Use Conventional Commits for commit messages, for example feat: add package to catalog, fix: handle package install failure,…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

7 rules. About 0 are common, 1 is distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    Use Conventional Commits for commit messages, for example feat: add package to catalog, fix: handle package install failure, or docs: …

    line 11
  2. Distinctive:

    Every page has a small front matter block at the top:

    line 50
  3. Very specific:

    No manual class="active" maintenance needed — it's automatic.

    line 72
  4. Very specific:

    Create docs/docs/[name].html (or docs/docs/packages/[name].html) with front matter:

    line 80
  5. Very specific:

    Write the page content (HTML, no surrounding boilerplate — the layout provides head/nav/sidebar/footer).

    line 88
  6. Very specific:

    Add a <a href="..." class="sidebar-link ..."> entry to docs/_includes/sidebar.html.

    line 89
  7. Very specific:

    Add prev/next navigation links at the bottom of the page content using <nav class="prev-next">.

    line 90

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

AGENTS.md

Project overview

LazyPi is an opinionated installer for the Pi coding agent. It provides a curated catalog of Pi extensions, themes, skills, and workflow tools so users can run one command and get a complete Pi setup.

The CLI is published to npm as @robzolkos/lazypi. The main executable is bin/lazypi.mjs, with package metadata and install behavior centered around the PACKAGES catalog in that file.

Git guidance

Use Conventional Commits for commit messages, for example feat: add package to catalog, fix: handle package install failure, or docs: update package documentation.

Site / docs

The site at lazypi.org is a Jekyll site in docs/, compiled automatically by GitHub Pages on every push to master. Source files are in docs/, build output (docs/_site/) is gitignored.

Structure

docs/
  _config.yml          — Jekyll config (title, url, excludes)
  _layouts/
    default.html       — top-level pages (index, faq, themes): head + nav + content + footer
    docs.html          — docs sub-pages: head + nav + sidebar + docs-shell + content + footer
  _includes/
    nav.html           — shared site nav; active link detected via page.url
    footer.html        — shared footer
    sidebar.html       — docs sidebar; active link detected via page.url
  assets/css/
    site.css           — CSS variables, body, nav, footer (all pages)
    index.css          — landing page styles
    faq.css            — FAQ page styles
    themes.css         — themes page styles
  docs.css             — docs sub-page layout (sidebar, content, tables, callouts)
  index.html           — landing page
  faq.html             — FAQ page
  themes.html          — themes gallery page
  docs/                — docs section
    index.html         — docs overview
    first-steps.html
    installation.html
    updating.html
    removing.html
    packages/          — one page per package
      *.html

Front matter

Every page has a small front matter block at the top:

---
layout: default          # or "docs" for docs sub-pages
title: "Page Title"
description: "..."       # optional, used for meta description
extra_css: /assets/css/index.css  # optional, for page-specific styles
---

Docs pages use layout: docs and need only title (description is optional, no extra_css needed).

Updating the nav or footer

Edit docs/_includes/nav.html or docs/_includes/footer.html. The change propagates to every page on the next build.

The nav uses Liquid conditionals for the active state:

<a href="/faq.html"{% if page.url == '/faq.html' %} class="active"{% endif %}>FAQ</a>

No manual class="active" maintenance needed — it's automatic.

Updating the sidebar

Edit docs/_includes/sidebar.html. Active state uses the same page.url pattern as the nav. When adding a new docs page, add a link here too.

Adding a new docs page

  1. Create docs/docs/[name].html (or docs/docs/packages/[name].html) with front matter:
    ---
    layout: docs
    title: "Page Title — LazyPi Docs"
    description: "Optional description."
    ---
  2. Write the page content (HTML, no surrounding boilerplate — the layout provides head/nav/sidebar/footer).
  3. Add a <a href="..." class="sidebar-link ..."> entry to docs/_includes/sidebar.html.
  4. Add prev/next navigation links at the bottom of the page content using <nav class="prev-next">.

Adding a package page

Package pages live in docs/docs/packages/. Use an existing page (e.g. subagents.html) as a template:

---
layout: docs
title: "Package Name — LazyPi Docs"
---
<h1>Package Name</h1>
<p class="page-desc">One-line description.</p>

<h2>What it does</h2>
<p>...</p>

<h2>Why it's included</h2>
<p>...</p>

<h2>Commands</h2>
<table>...</table>

<div class="learn-more">
  <a href="https://github.com/..." target="_blank" rel="noopener">→ GitHub — owner/repo</a>
</div>

<nav class="prev-next">
  <a href="/docs/packages/prev-page.html" class="prev-next-link">
    <span class="prev-next-label">Previous</span>← Previous
  </a>
  <a href="/docs/packages/next-page.html" class="prev-next-link next">
    <span class="prev-next-label">Next</span>Next →
  </a>
</nav>

Local preview

Requires Ruby + Bundler (one-time setup):

cd docs
gem install bundler
bundle install

Then:

npm run docs:serve   # serves at http://localhost:4000 with livereload

GitHub Pages uses the github-pages gem (specified in docs/Gemfile), which pins Jekyll and plugin versions to match what GitHub runs. Local and production output will be identical.

Changing styles

  • Nav or footer styles — edit docs/assets/css/site.css
  • Docs layout styles (sidebar, content area, tables, callouts) — edit docs/docs.css
  • Landing page styles — edit docs/assets/css/index.css
  • FAQ styles — edit docs/assets/css/faq.css
  • Themes page styles — edit docs/assets/css/themes.css

CSS variables (colors, spacing tokens) are defined at the top of docs/assets/css/site.css.

Adding videos

Videos are driven by docs/_data/videos.yml. Each entry has a category, id (for anchor links), optional description, and a list of videos:

- category: Intro to Pi
  id: intro
  description: "New to Pi? Start here."
  videos:
    - id: dQw4w9WgXcQ       # YouTube video ID (from ?v= in the URL)
      title: "Video title"
      channel: "Channel name"
      duration: "12:34"        # optional, shown as badge on thumbnail (use H:MM:SS for >1hr)

The YouTube thumbnail is loaded automatically from img.youtube.com/vi/{id}/mqdefault.jpg — no API key needed. Add a video by appending to the right category block in the YAML file. The four categories are Intro to Pi, Full Course Pi, Advanced Pi, and Slice of Pi.

Catalog updates on the landing page

The catalog grid on docs/index.html and the themes data array in docs/themes.html are maintained manually. When adding a package to the CLI catalog (PACKAGES in bin/lazypi.mjs), update the catalog grid in docs/index.html to match.

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.