# AGENTS.md

Command-line program to download videos from YouTube.com and other video sites

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make clean
make install
make codetest
make test          # run the test suite, must pass before any commit
make ot
make offlinetest
```

## Layout

- `youtube_dl/` 844 source files
- `test/`       32 source files
- `devscripts/` 28 source files
- `docs/`       1 source file

## Conventions

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

## Gotchas

- `youtube_dl/utils.py` is 208KB. 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.