agentleFS
Sign inStart free
zylon-aizylon-ai/private-gpt/ui/AGENTS.md

private-gpt / ui

AGENTS.md58k starsChanged 2 years agoApache-2.0View on GitHub

This file is for Codex and other OpenAI-style coding agents working in ./ui. Read these files in order before changing behavior, UI, or API wiring:

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read these files in order before changing behavior, UI, or API wiring:

    line 7
  2. Distinctive:

    Keep the app as a simple static demo.

    line 17
  3. Very specific:

    Keep index.html as the only runtime implementation file unless the user explicitly asks for a different structure.

    line 18
  4. Very specific:

    Treat docs/SOURCE_OF_TRUTH.md as the canonical pointer to API contract paths and documentation ownership.

    line 19
  5. Very specific:

    Update the relevant docs in docs/ whenever behavior, visuals, persistence, security posture, or API request/response handling changes.

    line 20
  6. Very specific:

    Follow the validation steps documented in README.md and docs/SOURCE_OF_TRUTH.md.

    line 24
  7. Distinctive:

    If implementation and docs disagree, fix the disagreement in the same change.

    line 25
  8. Distinctive:

    When finishing work, summarize what changed, what validation ran, and any known limitations.

    line 26

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

Codex Instructions

This file is for Codex and other OpenAI-style coding agents working in ./ui.

Read First

Read these files in order before changing behavior, UI, or API wiring:

  1. README.md
  2. docs/SOURCE_OF_TRUTH.md
  3. docs/PRD.md
  4. docs/STYLE_GUIDE.md
  5. index.html

Scope

  • Keep the app as a simple static demo.
  • Keep index.html as the only runtime implementation file unless the user explicitly asks for a different structure.
  • Treat docs/SOURCE_OF_TRUTH.md as the canonical pointer to API contract paths and documentation ownership.
  • Update the relevant docs in docs/ whenever behavior, visuals, persistence, security posture, or API request/response handling changes.

Codex-Specific Notes

  • Follow the validation steps documented in README.md and docs/SOURCE_OF_TRUTH.md.
  • If implementation and docs disagree, fix the disagreement in the same change.
  • When finishing work, summarize what changed, what validation ran, and any known limitations.

Download now (ZIP)

Trending

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Aug 30: 0 new projectsWeek of Sep 6: 0 new projectsWeek of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projects
Aug 2026Sep 2026Oct 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Who's talking about zylon-ai/private-gpt

The biggest 5 of 70 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 70

Talked about on GitHub, YouTube, the web and Bluesky (70 times).

On GitHub · 50

45 more on GitHub

On YouTube · 14

9 more on YouTube
  • 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 28,693 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 repositoryOne other file it gives its agents.

Does it work?

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

Reviews can't be read right now.

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.

Check your setup, free