# AGENTS.md

An Open Source implementation of Notebook LM with more flexibility and features

## Setup

```
uv sync
```

## Commands

```
make database
make run
make frontend
make lint                    # lint
make ruff
make docker-buildx-prepare
```

## Layout

- `frontend/`      243 source files
- `tests/`         47 source files
- `open_notebook/` 44 source files
- `api/`           32 source files
- `scripts/`       6 source files
- `commands/`      4 source files

## Conventions

- Tests live alongside the code they cover, following `frontend/src/app/(dashboard)/notebooks/components/ChatColumn.test.tsx`.
- CI defines what passing means. See `.github/workflows/build-and-release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- 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.