# AGENTS.md

🔥 1Panel is a modern, open-source Linux server management panel and a lightweight AI management platform.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make clean_assets
make upx_bin
make build_frontend
make build_core_on_linux
make build_agent_on_linux
make build_core_on_darwin
```

## Layout

- `frontend/` 764 source files
- `agent/`    644 source files
- `core/`     172 source files
- `scripts/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `agent/app/api/v2/docker_port_guard_test.go`.
- CI defines what passing means. See `.github/workflows/add-labels-for-pr.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `core/cmd/server/docs/docs.go` is 799KB. 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.