# AGENTS.md

Glances an Eye on your system. A top/htop alternative for GNU/Linux, BSD, macOS and Windows operating systems.

## Setup

```
pip install -r requirements.txt
```

## Commands

```
make alpine_images
make ubuntu_images
make help
make install-uv
make upgrade-uv
make venv
```

## Layout

- `glances/`    203 source files
- `tests/`      55 source files
- `tests-data/` 13 source files
- `docs/`       2 source files

## Conventions

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

## Gotchas

- `glances/outputs/static/public/glances.js` is 670KB. 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.