mirror of
https://github.com/wu736139669/hapi.git
synced 2026-08-05 06:24:37 +00:00
weishu
4f03f29ac3
This commit rebrands the project from "Happy" to "HAPI" throughout the codebase, including documentation, comments, logs, and tool references. It also adds comprehensive README files for the server and web components, clarifies the monorepo structure in AGENTS.md and root README.md, and removes the outdated roadmap.md file. Changes include: - Rebrand references from Happy to HAPI in CLI, server, and web components - MCP tool names updated from mcp__happy__ to mcp__hapi__ - Process/service names updated consistently - New server/README.md with deployment and configuration guide - New web/README.md with stack and development instructions - Updated root README.md with quickstart guide - Updated AGENTS.md with cleaner structure documentation - Removed cli/roadmap.md (now superseded by documentation)
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# AGENTS.md
|
|
|
|
Short guide for AI agents in this repo. Prefer progressive loading: start with the root README, then package READMEs as needed.
|
|
|
|
## Repo layout
|
|
- `cli/` - hapi CLI, daemon, Codex/MCP tooling
|
|
- `server/` - Telegram bot + HTTP API + Socket.IO + SSE
|
|
- `web/` - React Mini App / PWA
|
|
|
|
## Reference docs
|
|
- `README.md` (user overview)
|
|
- `cli/README.md` (CLI behavior and config)
|
|
- `server/README.md` (server setup and architecture)
|
|
- `web/README.md` (web app behavior and dev workflow)
|
|
- `localdocs/` (optional deep dives)
|
|
|
|
## Shared rules
|
|
- TypeScript strict; no untyped code.
|
|
- Bun workspaces; run `bun` commands from repo root.
|
|
- Path alias `@/*` maps to `./src/*` per package.
|
|
- No backward compatibility: breaking format changes are allowed.
|
|
- Prefer 4-space indentation.
|
|
|
|
## Common commands (repo root)
|
|
bun run build
|
|
bun run build:single-exe
|
|
bun run typecheck
|
|
bun run dev:server
|
|
bun run dev:web
|
|
bun run test
|
|
|
|
## Key source dirs
|
|
- `cli/src/api/`, `cli/src/claude/`, `cli/src/commands/`, `cli/src/codex/`
|
|
- `server/src/web/`, `server/src/socket/`, `server/src/telegram/`, `server/src/sync/`
|
|
- `web/src/components/`, `web/src/api/`, `web/src/hooks/`
|