Skip to content

AI workflow

ArchForge is written so an agent can start without tribal knowledge. Humans and agents share the same files.

Start here

  1. Clone the five repos side by side. No submodules.
  2. Read ../ArchForgeSpec/repos.yaml (machine map).
  3. Read ../ArchForgeSpec/architecture.md (ports and envelopes).
  4. Open the current repo's AGENTS.md / CLAUDE.md.
  5. Load one skill from ../ArchForgeSpec/skills/index.yaml.

Do not load every skill. Progressive disclosure keeps context small.

Per-repo context

RepoWhat an agent should know
ArchForgeJava 25, Gradle, sa-token, two servers, Spotless. Contract sync: OpenAPI in Spec.
ArchForgeAdminVue 3 admin on :8848, /api:8080. {code,message,data}.
ArchForgeWebNext.js C-end on :3000:8081. ProblemDetail errors. Locale prefix /en /zh.
ArchForgeDocsVitePress only. Describe, do not invent APIs.
ArchForgeSpecConstitution. Change this first when a contract does not fit.

CLI and MCP

From the backend repo:

bash
./archforge --help
./archforge skills install --tool claude
./archforge --mcp

skills install copies agent skills into the tool's skill directory. --mcp runs a Phase-1 stdio MCP server so an IDE agent can call CLI commands without inventing shell.

Cross-repo change

Use the Spec skill cross-repo-change when an enum, path, or OpenAPI shape moves. Order: Spec → backend → clients. See contract-first.

Bootstrap

bash
cd ArchForge
./archforge init --write
./archforge infra up
FILE_STORAGE_TYPE=local ./gradlew :archforge-server-admin:bootRun

Then start Admin (pnpm dev on 8848) or Web (pnpm dev on 3000) in their repos.

Released under the MIT License.