agentleFS
rock3rrock3r/headroom/AGENTS.md

headroom

AGENTS.md8 starsChanged 40 days agoApache-2.0View on GitHub

Headroom is a native Android app that shows how much of your AI subscription quotas you have left (Claude, ChatGPT Codex, GitHub Copilot, Grok, Z.AI, Kimi Code, OpenCode Go, JetBrains AI, Muse). It has Material 3 Expressive UI, adaptive layouts, Remote Compose widgets for the home and lock screens, and a notification when a weekly limit resets. - Android 16 (API 36) and later only. compileSdk and targetSdk are 37. - An iOS app (SwiftUI, iOS 18 and later) in…

  • 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 repositoryOne other file it gives its agents.

The file

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

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

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the targeted test and see it fail for the right reason.

    line 30
  2. Distinctive:

    Write the minimum production code to make it pass.

    line 31
  3. Very specific:

    Do not edit config/detekt/detekt.yml, add baselines, or disable Lint checks without the owner's approval.

    line 41
  4. Very specific:

    Run ./gradlew ktfmtFormat instead of formatting by hand.

    line 45
  5. Distinctive:

    Keep changes to what the task asks for.

    line 49
  6. Distinctive:

    Never commit tokens, keys or real account data.

    line 53
  7. Very specific:

    Use JDK 21. ./gradlew check is the local gate and the CI gate.

    line 59

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

Headroom is a native Android app that shows how much of your AI subscription quotas you have left (Claude, ChatGPT Codex, GitHub Copilot, Grok, Z.AI, Kimi Code, OpenCode Go, JetBrains AI, Muse). It has Material 3 Expressive UI, adaptive layouts, Remote Compose widgets for the home and lock screens, and a notification when a weekly limit resets.

  • Android 16 (API 36) and later only. compileSdk and targetSdk are 37.
  • An iOS app (SwiftUI, iOS 18 and later) in iosApp/ shares the Kotlin business logic through Kotlin Multiplatform. See iosApp/README.md.
  • Kotlin, Jetpack Compose, Material 3 Expressive, Remote Compose. No Views, no Glance.
  • Plain constructor injection. There is no DI framework.

Source of truth docs

DocumentUse it for
docs/ARCHITECTURE.mdModule map, dependency direction, data flow
docs/TESTING.mdTDD flow, test layers, how to run each one
docs/STATIC-ANALYSIS.mddetekt, Compose Rules, ktfmt and Android Lint
docs/CONVENTIONS.mdFile placement, naming, git workflow

Non-negotiables

TDD first

  1. Write the test.
  2. Run the targeted test and see it fail for the right reason.
  3. Write the minimum production code to make it pass.
  4. Re-run the targeted test, then the module's check.

Details: docs/TESTING.md.

Zero tolerance for static analysis

./gradlew check must be green before every commit. It runs tests, detekt (with Compose Rules), ktfmt and Android Lint, and Lint treats every warning as an error.

  • Do not edit config/detekt/detekt.yml, add baselines, or disable Lint checks without the owner's approval.
  • Fix the cause. When a suppression is truly needed, keep it to one declaration or file and write down why next to it.
  • Run ./gradlew ktfmtFormat instead of formatting by hand.

Scope discipline

Keep changes to what the task asks for. Unrequested behaviour changes are regressions.

Secrets

Never commit tokens, keys or real account data. Tests use fixtures and fake data only. Sign-in tokens are stored encrypted on the device, with the device-local Android Keystore keyset excluded from backup and a backup-wrapped keyset unlocked via Android's Restore Credentials.

Running the build

Use JDK 21. ./gradlew check is the local gate and the CI gate. See the docs above for the individual tasks.

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.