agentreadme

Report · marked 26 Aug 2026

GyulyVGC/sniffnet

An agent will struggle here, mostly for fixable reasons.

Rust · 40,686 stars · 557 files · branch main

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
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

The full marking

Every deduction below names the file or setting it came from.

Instructions 2/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 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 10/20 C+

Whether an agent can install the project and get it running without a human.

Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
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 2/2
dockerfile gives a known-good environment.
Verification loop 15/22 B

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 4/8
8 test files against 162 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. resources/test/ip_blacklist_invalid.txt, resources/test/ip_blacklist_real_cidr_ranges.txt, resources/test/ip_blacklist_valid.txt
Test command is discoverable 7/7
An agent can find and run `cargo test`.
Continuous integration 4/4
5 GitHub Actions workflows define what "passing" means.
Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
Static type checking n/a
Not applicable — the Rust compiler type checks every build.
Context economy 15/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 50 patterns.
File sizes fit in context 4/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.
src/translations/translations.rs — 132KB
Repository weight 2/5
About 355MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 — drafted for GyulyVGC/sniffnet
# AGENTS.md

Comfortably monitor your network traffic 🕵️‍♂️

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `src/`       158 source files
- `resources/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `resources/test/ip_blacklist_invalid.txt`.
- CI defines what passing means. See `.github/workflows/codeql.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/translations/translations.rs` is 132KB. It will not fit comfortably in context, so read it in parts.

---

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/GyulyVGC/sniffnet.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 51 out of 100

[![agent ready](https://agentreadme.com/badge/GyulyVGC/sniffnet.svg)](https://agentreadme.com/GyulyVGC/sniffnet)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ farion1231/cc-switch 63 B rustdesk/rustdesk 70 B+ openai/codex 82 A- rust-lang/rust 65 B tauri-apps/tauri 64 B

All Rust repositories

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.

Open an issue, already filled in