agentleFS
Sign inStart free
BasedHardwareBasedHardware/omi/docs/AGENTS.md

omi

AGENTS.md14k starsChanged 10 months agoMITView on GitHub

This folder is the public Mintlify site "Omi Developers" at docs.omi.me, for builders — not the repo's internal wiki. End-user how-tos belong in the help center (help.omi.me): link, never duplicate. Unlisted MDX/MD under docs/ is still a public URL; absence from docs.json is not a secrecy control. Developer platform (apps, API, MCP, CLI, SDKs), hardware and DIY, how Omi works, contribution setup, and developer-platform reference. Nothing else. Do not dump a design note, runbook, invariant, flag table, or agent-only rule…

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

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

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

    Every MDX page appears in docs.json.

    line 29

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

Public documentation site

This folder is the public Mintlify site "Omi Developers" at docs.omi.me, for builders — not the repo's internal wiki. End-user how-tos belong in the help center (help.omi.me): link, never duplicate. Unlisted MDX/MD under docs/ is still a public URL; absence from docs.json is not a secrecy control.

Allowed on the site

Developer platform (apps, API, MCP, CLI, SDKs), hardware and DIY, how Omi works, contribution setup, and developer-platform reference. Nothing else. Do not dump a design note, runbook, invariant, flag table, or agent-only rule here — put it next to the owning code (backend/docs/, desktop/macos/docs/, .github/agent-docs/) and link it.

Style

Plain, direct, second person. No hype, no emoji, short pages. No volatile facts in hand-written prose: prices, review/turnaround promises, counts like "22+ integrations", STT/LLM vendor or model names, tool version pins, personal social handles — link the owning source instead. Enforced by .github/scripts/check_docs_volatile_facts.py (its allowlist needs a reason a reviewer can check).

Navigation, redirects, checks

  • Tabs: Get started / Build / Hardware / How Omi works / Contribute / Reference. Every MDX page appears in docs.json; after moving or deleting a page, add a redirects entry and fix in-repo links in the same change.
  • check_docs_site.py gates nav→file, orphans, internal links, image refs, and redirect consistency on every docs change. Generated pages (edit the generator or source, never the block): CLI commands ← sdks/python-cli/tools/gen_commands_doc.py; MCP tool inventory ← scripts/generate_mcp_tools_doc.py.

Changelog

doc/reference/changelog.mdx covers developer-platform changes only (API, MCP, SDK, CLI, firmware/BLE). A merged PR changing one of those surfaces adds a one-line past-tense entry with the PR link atop the matching month. App release notes never go there.

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