agentreadme

Report · marked 10 Oct 2026

virattt/ai-hedge-fund

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

Python · 63,926 stars · 115 files · branch main

62 /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 16/18Whether an agent can install the project and get it running without a human. Losing marks on pinned runtime version.Verification loop 18/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on continuous integration and static type checking.Context economy 18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability 7/10How quickly anything new can orient itself. Losing marks on written documentation and repository description.

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
Continuous integration
A CI workflow doubles as machine-readable documentation: it's the one file that states, unambiguously, the exact commands that must succeed.

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

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

✓Deterministic install 6/6
poetry.lock pins the dependency tree.
Found poetry.lock
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
pyproject.toml scripts
✓Environment config 4/4
.env.example documents what the app needs to 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 n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 18/25 B+

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 95 source files.
e.g. hedge_fund/backtesting/test_backtest.py, hedge_fund/backtesting/test_fund.py, hedge_fund/brokers/test_paper.py
✓Test command is discoverable 7/7
An agent can find and run `make test`.
✗Continuous integration 0/4
No CI config. Nothing outside a developer's laptop enforces correctness.
A CI workflow doubles as machine-readable documentation: it's the one file that states, unambiguously, the exact commands that must succeed.
✓Lint and format rules 3/3
pyproject.toml 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 18/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 3/3
.gitignore covers 41 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.
hedge_fund/tui/app.py — 135KB
✓Repository weight 5/5
About 4.2MB 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 virattt/ai-hedge-fund 
# AGENTS.md

An AI Hedge Fund Team

## Setup

```
poetry install
```

## Commands

```
make dev       # run locally
make console
make test      # run the test suite, must pass before any commit
```

## Layout

- `hedge_fund/` 95 source files

## Conventions

- Tests live alongside the code they cover, following `hedge_fund/backtesting/test_backtest.py`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `hedge_fund/tui/app.py` is 135KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/virattt/ai-hedge-fund.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Python AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

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 62 out of 100

[![agent ready](https://agentreadme.com/badge/virattt/ai-hedge-fund.svg)](https://agentreadme.com/virattt/ai-hedge-fund)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 89 A yt-dlp/yt-dlp 54 C+ microsoft/markitdown 48 C+ Significant-Gravitas/AutoGPT 65 B

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