agentleFS
Sign inStart free
BasedHardwareBasedHardware/omi/AGENTS.md

omi

AGENTS.md14k starsChanged 10 months agoMITView on GitHub

Read the guide for the area you are changing. CLAUDE.md points here. Keep this file a router. Add repository-specific facts at their owning guide; omit generic agent behavior and duplicated procedures. Size budgets live in .github/scripts/check_agents_md_lean.py.

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 2 mentionsFeb 2026: 0 mentionsMar 2026: 1 mentionApr 2026: 13 mentionsMay 2026: 1 mentionJun 2026: 0 mentionsJul 2026: 1 mentionAug 2026: 1 mentionSep 2026: 5 mentionsOct 2026: 40 mentionsNov 2026: 2 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the BasedHardware/omi repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about BasedHardware/omi

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

See all 83

Talked about on GitHub, YouTube, Bluesky and Hacker News (83 times).

On GitHub · 50

45 more on GitHub

On YouTube · 21

16 more on YouTube

On Bluesky · 7

2 more on Bluesky

The file

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

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

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the guide for the area you are changing.

    line 3
  2. Very specific:

    Use a task worktree based on current origin/main.

    line 31
  3. Very specific:

    Run the component's documented verification and make preflight.

    line 35
  4. Very specific:

    Keep this file a router. Add repository-specific facts at their owning guide.

    line 37

≈ “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

Omi agent guide

Read the guide for the area you are changing. CLAUDE.md points here.

Routes

Working onRead
Backendbackend/AGENTS.md
Flutter appapp/AGENTS.md
macOS desktopdesktop/macos/AGENTS.md
Windows/Linux desktopdesktop/windows/AGENTS.md
Web app / adminweb/app/AGENTS.md / web/admin/AGENTS.md
Firmwareomi/firmware/AGENTS.md
CI / deployment workflows.github/AGENTS.md
Public documentationdocs/AGENTS.md
Product behavior / UIPRODUCT.md, product/invariants/; macOS UI: desktop/macos/docs/ux-contract.md
Shared client behaviorcontracts/parity/README.md
Released-client compatibilitycontracts/client-compat/
Fallbacks / fail-open paths.github/agent-docs/fallback-telemetry.md
Plan catalog.github/agent-docs/plan-catalog.md
App E2Eapp/e2e/SKILL.md, desktop/macos/e2e/SKILL.md
Cursor Cloud environment.cursor/cloud-agent-environment.md
Contributions / PR requirementsdocs/doc/developer/Contribution.mdx
Failure-class classificationproduct/failure-classes.md, scripts/failure-class
Formatting.github/agent-docs/formatting.md
Agent documentation / new checks.github/agent-docs/doc-maintenance.md

Repository conventions

  • Use a task worktree based on current origin/main. make setup installs the repository hooks, including staged-file formatting. Keep Git identity in the user's configuration; temporary test identities use git -c.
  • Upstream main changes land through PRs with merge commits, never squash or direct pushes.
  • macOS development uses dev or omi-* named bundles. Do not stop or replace the production Omi or Omi Beta apps; bundle details and commands live in the macOS guide.
  • Migrate in-tree callers together rather than preserving retired APIs with compatibility wrappers. Released clients follow the compatibility contracts above.
  • Run the component's documented verification and make preflight. For PR metadata, start with scripts/pr-preflight --suggest, then validate the draft with scripts/pr-preflight --pr-body-file <file>. These tools identify required invariant citations and failure-class declarations.

Keep this file a router. Add repository-specific facts at their owning guide; omit generic agent behavior and duplicated procedures. Size budgets live in .github/scripts/check_agents_md_lean.py.

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