# AGENTS.md

Portable file server with accelerated resumable uploads, dedup, WebDAV, SFTP, FTP, TFTP, zeroconf, media indexer, thumbnails++ all in one file

## Setup

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

## Commands

```
ruff check .   # lint
```

## Layout

- `copyparty/` 95 source files
- `bin/`       64 source files
- `scripts/`   56 source files
- `tests/`     17 source files
- `contrib/`   14 source files
- `docs/`      6 source files

## Conventions

- Tests live alongside the code they cover, following `scripts/pyinstaller/up2k.spec.sh`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `copyparty/httpcli.py` is 279KB. 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.