Report · marked 26 Aug 2026
permissionlesstech/bitchat
An agent will struggle here, mostly for fixable reasons.
Swift · 35,923 stars · 633 files · branch main
54
/100
C+
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
6/14Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and pinned runtime version.Verification loop
18/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist.Context economy
13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
10/10How quickly anything new can orient itself. Full marks.
Higher is better. Accent marks what is costing you most.
Fix these first
01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
The full marking
Every deduction below names the file or setting it came from.
Instructions 3/27 F
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
✗Instruction quality
0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
✓README as an entry point
3/3
README has a clear getting-started section.
Setup 6/14 C
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
justfile
scripts/ directory
–Environment config
n/a
Not applicable — this reads as a library, with no environment to configure.
✗Pinned runtime version
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
–Reproducible environment
n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 18/22 A-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
4/8
18 test files against 535 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. localPackages/BitFoundation/Tests/BitFoundationTests/AnnounceV2PacketTests.swift, localPackages/BitFoundation/Tests/BitFoundationTests/BinaryProtocolPaddingTests.swift, localPackages/BitFoundation/Tests/BitFoundationTests/BinaryProtocolTests.swift
✓Test command is discoverable
7/7
An agent can find and run `just test`.
✓Continuous integration
4/4
5 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
.swiftlint.yml encodes the house style.
–Static type checking
n/a
Not applicable — the Swift compiler type checks every build.
Context economy 13/20 B
Whether the repo fits in a context window, or fights it.
✓No committed build output
6/6
No generated directories committed.
✓.gitignore hygiene
3/3
.gitignore covers 45 patterns.
✗File sizes fit in context
0/6
1 source file is over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
bitchat/Services/BLE/BLEService.swift — 315KB
✗Repository weight
4/5
About 115.9MB checked out, which is comfortable.
Here is your AGENTS.md
Drafted from what is actually in this repository: the install
command from your lockfile, the commands you already declare, your real directory layout. Anything
marked TODO needs a person. Save it at the root as AGENTS.md.
# AGENTS.md bluetooth mesh chat, IRC vibes ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` # TODO: nothing declares a build or test command, so an agent has to guess. # This is the single most valuable section of this file. Fill it in. ``` ## Layout - `bitchat/` 269 source files - `bitchatTests/` 203 source files - `localPackages/` 55 source files - `scripts/` 6 source files - `bitchatShareExtension/` 1 source file ## Conventions - Tests live alongside the code they cover, following `localPackages/BitFoundation/Tests/BitFoundationTests/AnnounceV2PacketTests.swift`. - CI defines what passing means. See `.github/workflows/arti-provenance.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `bitchat/Services/BLE/BLEService.swift` is 315KB. It will not fit comfortably in context, so read it in parts. - No lockfile is committed, so an install here may not match what CI produced. --- Drafted by agentreadme.com from what is in this repository. Everything marked TODO needs a human. Check it in as AGENTS.md at the root.
Open the raw markdown
or
curl -o AGENTS.md agentreadme.com/draft/permissionlesstech/bitchat.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/permissionlesstech/bitchat)Other Swift repositories, marked
Think this mark is wrong?
Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.