# AGENTS.md

Certbot is EFF's tool to obtain certs from Let's Encrypt and (optionally) auto-enable HTTPS on your server.  It can also act as a client for any other CA that uses the ACME protocol.

## Setup

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

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `certbot/`                    187 source files
- `certbot-ci/`                 28 source files
- `acme/`                       27 source files
- `tools/`                      21 source files
- `certbot-compatibility-test/` 14 source files
- `certbot-dns-route53/`        8 source files

## Conventions

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

## Gotchas

- `certbot/src/certbot/_internal/tests/main_test.py` is 121KB. 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.