# AGENTS.md

A cross-platform desktop All-in-One assistant for Claude Code, Codex, OpenCode, OpenClaw, Grok Build & Hermes Agent. Only official website: ccswitch.io

## Setup

```
pnpm install
```

## Commands

```
pnpm dev              # run locally
pnpm build            # produce a build
pnpm typecheck        # type check without emitting
pnpm format           # format
pnpm tauri
pnpm dev:renderer
pnpm build:renderer
pnpm format:check
```

## Layout

- `src/`       344 source files
- `src-tauri/` 238 source files
- `tests/`     128 source files
- `scripts/`   2 source files

## Conventions

- Tests live alongside the code they cover, following `docs/user-manual/en/4-proxy/4.5-model-test.md`.
- 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/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src-tauri/src/services/proxy.rs` is 376KB. 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.
