agentleFS
Sign inStart free
RubiYHRubiYH/teamem/docs/AGENTS.md

teamem

AGENTS.md1 starsChanged 6 months agoApache-2.0View on GitHub

Public-facing documentation for Teamem users and operators. These files explain quickstart, setup, Claude Code plugin usage, deployment, troubleshooting, and runtime behavior. Keep public docs concise and aligned with shipped CLI/plugin behavior. - Public docs are user/operator guidance, not internal design scratchpads. Put private design history, ADRs, and implementation plans under .docs/. - When docs mention a command, verify the command exists in the relevant surface: package.json scripts, src/cli/teamem.ts, packages/bootstrapper-cli, or plugin/commands/*.md. - When docs mention env vars, keep the matching…

  • Reads credentials
  • 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 31,439 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 repository8 other files it gives its agents.

The file

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

6 rules. About 0 are common, 1 is distinctive, and 5 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.

  • 5

    Very specific

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

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

    When docs mention a command, verify the command exists in the relevant surface: package.json scripts, src/cli/teamem.ts, …

    line 19
  2. Very specific:

    When docs mention env vars, keep the matching .env.example file aligned: root .env.example for the runtime, apps/web/.env.example for …

    line 22
  3. Very specific:

    Keep Cloud/control-plane wording separate from runtime/plugin identity.

    line 24
  4. Very specific:

    Do not document ~/.claude/plugins/cache/...

    line 26
  5. Distinctive:

    If a deploy flow changes ordering, migrations, auth tables, PostHog config, OAuth config, or runtime provisioning semantics, update the …

    line 36
  6. Very specific:

    Run bun run format:check for docs-only formatting checks when practical.

    line 42

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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
<!-- Parent: ../AGENTS.md --><!-- Created: 2026-05-26 -->

docs

Purpose

Public-facing documentation for Teamem users and operators. These files explain quickstart, setup, Claude Code plugin usage, deployment, troubleshooting, and runtime behavior. Keep public docs concise and aligned with shipped CLI/plugin behavior.

For AI Agents

Working In This Directory

  • Public docs are user/operator guidance, not internal design scratchpads. Put private design history, ADRs, and implementation plans under .docs/.
  • When docs mention a command, verify the command exists in the relevant surface: package.json scripts, src/cli/teamem.ts, packages/bootstrapper-cli, or plugin/commands/*.md.
  • When docs mention env vars, keep the matching .env.example file aligned: root .env.example for the runtime, apps/web/.env.example for Teamem Cloud.
  • Keep Cloud/control-plane wording separate from runtime/plugin identity. Teamem Cloud provisions and manages setup; the runtime/plugin own coordination.
  • Do not document ~/.claude/plugins/cache/... edits as a normal workflow.

Deployment Docs

  • Runtime/self-host docs must stay aligned with root .env.example, Docker/Docker Compose behavior, TEAMEM_PUBLIC_URL, and provisioning-token requirements.
  • Teamem Cloud docs must stay aligned with apps/web/.env.example, apps/web/db/migrations/, apps/web/scripts/deploy-smoke.ts, and the bun run web:smoke:deploy gate.
  • If a deploy flow changes ordering, migrations, auth tables, PostHog config, OAuth config, or runtime provisioning semantics, update the deploy runbook in the same change.

Verification

  • Run bun run format:check for docs-only formatting checks when practical.
  • For command or deploy docs, prefer a targeted smoke or dry-run from the owning surface before claiming the docs are current.
<!-- MANUAL: -->

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.

Check your setup, free