# AGENTS.md

LocalAI is the open-source AI engine. Run any model - LLMs, vision, voice, image, video - on any hardware. No GPU required.

## Setup

```
go mod download
```

## Commands

```
make rebuild
make clean
make clean-tests
make install-go-tools
make react-ui
make react-ui-docker
```

## Layout

- `core/`    1452 source files
- `backend/` 594 source files
- `pkg/`     292 source files
- `tests/`   61 source files
- `scripts/` 15 source files
- `cmd/`     10 source files

## Conventions

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

## Gotchas

- `tests/e2e-aio/sample_data_test.go` is 3440KB. It will not fit comfortably in context, so read it in parts.

---

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.