agentleFS
WireCatLabsWireCatLabs/cli-core/CLAUDE.md

cli-core

CLAUDE.md2 starsChanged 4 days agoApache-2.0View on GitHub

The messenger-neutral half of tg-cli and max-cli, published as @wirecat/cli-core. Start with the one page that covers what you are about to touch: - docs/dev/ARCHITECTURE.md — the modules, the store and its migrations, the command skeleton, who consumes it. - docs/dev/CONVENTIONS.md — max-cli's conventions, and what differs here. - docs/dev/TESTING.md — the sandbox, the coverage floor, no real waits. - docs/dev/BACKLOG.md — open work; docs/dev/COORDINATION.md — migration numbers and releases across sessions. Security audits of this repository follow the shared…

The file

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

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

  • 4

    Very specific

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

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

    Nothing here knows a messenger: No provider library, no adapter.

    line 18
  2. Very specific:

    No test and no branch build may open the real file (~/.local/share/WireCat/wirecat.db) — MESSAGING_STORE points elsewhere.

    line 20
  3. Very specific:

    Never delete or clean up mid-task.

    line 40
  4. Very specific:

    Every pull request runs three checks.

    line 54

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.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
CLAUDE.md

cli-core — working rules

The messenger-neutral half of tg-cli and max-cli, published as @wirecat/cli-core. Start with the one page that covers what you are about to touch:

  • docs/dev/ARCHITECTURE.md — the modules, the store and its migrations, the command skeleton, who consumes it.
  • docs/dev/CONVENTIONS.md — max-cli's conventions, and what differs here.
  • docs/dev/TESTING.md — the sandbox, the coverage floor, no real waits.
  • docs/dev/BACKLOG.md — open work; docs/dev/COORDINATION.md — migration numbers and releases across sessions.

Security audits of this repository follow the shared security method in cli-testing; vulnerabilities are reported as the security policy says.

The constraints that shape everything

  1. Nothing here knows a messenger. No provider library, no adapter; biome.json refuses them.
  2. The store is the owner's system of record. Migrations are forward-only and cannot be undone. No test and no branch build may open the real file (~/.local/share/WireCat/wirecat.db) — MESSAGING_STORE points elsewhere.
  3. Other sessions work here at the same time. Work in a worktree off origin/main, rebase before pushing, and take a migration number in COORDINATION.md before writing it.
  4. A change reaches tg-cli and max-cli only through a release. Both pin an exact version.
  5. Release when a consumer needs the merged code, at any time (WC-REL-8) — README, "How often, and what may break". bin/release publishes the next free version through GitHub; a change that may break a caller goes under "Changed — may break callers" in the changelog.

Comments

Sparse, and only why. No comment restating the line, no banners, no narrating the change.

Documents

They state the current facts only: rewrite a changed fact, delete a finished plan or done backlog item; the changelog keeps history (CONVENTIONS.md).

Deletions

Never delete or clean up mid-task. Append a line to CLEANUP.md at the root — the path, why, the date — and do the removals in one batch after the owner confirms. Never kill a process by name — find the PID, confirm it is yours, kill that PID.

Committing

Conventional commits. The pre-commit hook checks staged lint and secrets; no other local checks are required by default.

A branch off main, in a worktree, and a pull request. A user-visible change gets a line under ## Unreleased in CHANGELOG.md. bin/release publishes; when the version is already taken it moves to the next free one and renames the changelog heading with it.

Development check budget

Local commits check only staged lint and secrets. There is no pre-push check. Every pull request runs three checks. The fast standards job (standards.yml) checks config integrity, lint, Markdown, ci:quick (the typecheck and the command lint) and the new commits for secrets. The pull request validation (pr.yml) runs the full Linux validation, ci.yml: lint, typecheck, the tests on two runners with the coverage floor checked on their merged report, build, docs:check, the schema and dist checks, Bun, old Node, the SQLite restart and parity, which builds tg-cli, max-cli, whatsapp-cli and cli-template against the branch. The security checks (security.yml) run CodeQL, zizmor and gitleaks; CodeQL analyses python, c-cpp and java-kotlin only when a file of theirs changes. A pull request that changes only CHANGELOG.md and the version against a main already proven green (bin/release's fold and version pull requests) runs only docs:check and the changelog shape test, and reports the other required checks as passed (docs/dev/TESTING.md). The same ci.yml runs again in full on each merge to main (no publishing). Browser and platform suites run for releases, explicit manual validation, and monthly nonpublishing validation. See the shared policy.

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.