Report · marked 25 Aug 2026

zsh-users/zsh-autosuggestions

An agent can work here, but it will waste turns finding its footing.

Shell · 36,014 stars · 61 files · branch master

69 /100 B

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 18/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on .gitignore hygiene.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

Higher is better. Accent marks what is costing you most.

Fix these first

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Static type checking

A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

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 18/20 A

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

✓Deterministic install 6/6

gemfile.lock pins the dependency tree.

Found gemfile.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

Makefile

✗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 2/2

The language runtime version is pinned.

Found .ruby-version

✓Reproducible environment 2/2

dockerfile gives a known-good environment.

Verification loop 22/25 A

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

✓Tests exist 8/8

27 test files against 28 source files.

e.g. spec/async_spec.rb, spec/integrations/auto_cd_spec.rb, spec/integrations/bracketed_paste_magic_spec.rb

✓Test command is discoverable 7/7

An agent can find and run `make test`.

✓Continuous integration 4/4

1 GitHub Actions workflow define what "passing" means.

✓Lint and format rules 3/3

.rubocop.yml encodes the house style.

✗Static type checking 0/3

No static type checking.

A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

Context economy 19/20 A+

Whether the repo fits in a context window, or fights it.

✓No committed build output 6/6

No generated directories committed.

✗.gitignore hygiene 2/3

.gitignore has only 1 rules.

Start from a standard template for your stack. It prevents the previous problem before it happens.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✓Repository weight 5/5

About 583KB 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 — drafted for zsh-users/zsh-autosuggestions

# AGENTS.md

Fish-like autosuggestions for zsh

## Setup

```
bundle install
```

## Commands

```
make clean
make test    # run the test suite, must pass before any commit
```

## Layout

- `spec/` 27 source files

## Conventions

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

---

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/zsh-users/zsh-autosuggestions.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](https://agentreadme.com/badge/zsh-users/zsh-autosuggestions.svg)](https://agentreadme.com/zsh-users/zsh-autosuggestions)

Other Shell repositories, marked

obra/superpowers 68 B mattpocock/skills 68 B ohmyzsh/ohmyzsh 46 C msitarzewski/agency-agents 42 C d3/d3 68 B nvm-sh/nvm 77 B+

All Shell 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