# AGENTS.md

Jan is an open source alternative to ChatGPT that runs 100% offline on your computer.

## Setup

```
yarn install
```

## Commands

```
yarn dev         # run locally
yarn build       # produce a build
yarn test        # run the test suite, must pass before any commit
yarn lint        # lint
yarn ios
yarn android
yarn test:core
yarn test:web
```

## Layout

- `web-app/`    695 source files
- `src-tauri/`  147 source files
- `core/`       101 source files
- `docs/`       67 source files
- `extensions/` 59 source files
- `autoqa/`     16 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/jan-linter-and-test.yml`.
- CI defines what passing means. See `.github/workflows/auto-assign-author.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src-tauri/static/swagger-ui/swagger-ui-bundle.js` is 1472KB. 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.