# AGENTS.md

CasaOS - A simple, easy-to-use, elegant open-source Personal Cloud system.

## Setup

```
go mod download
```

## Commands

```
go start            # run the app
go build            # produce a build
go clean
go generate:local
go generate:npx
go generate:ts
```

## Layout

- `pkg/`     38 source files
- `model/`   26 source files
- `service/` 23 source files
- `route/`   20 source files
- `build/`   18 source files
- `drivers/` 14 source files

## Conventions

- Tests live alongside the code they cover, following `pkg/sqlite/db_test.go`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/add_issues_to_projects.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.

---

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.