diff --git a/CLAUDE.md b/CLAUDE.md index 2f070ef2..588ac849 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,7 +2,18 @@ This file gives coding agents high-signal guidance for this repository. -## 1. Documentation Scope +## 1. Project Context + +Super Multica is a distributed AI agent framework/product monorepo. +It is used to run local-first agent workflows and support CLI/Desktop/Web/Gateway-based usage. + +Core purpose: + +- execute agent tasks with tools and skills +- persist sessions/profiles/credentials across runs +- support development, testing, and operational automation workflows + +## 2. Documentation Scope Documentation in this repo should prioritize: @@ -10,10 +21,10 @@ Documentation in this repo should prioritize: 2. Testing methods 3. Operational process -Project-intro and architecture explanations are intentionally minimized. +Architecture explanations should stay minimal in docs. Treat source code as the architecture source of truth. -## 2. Core Workflow Commands +## 3. Core Workflow Commands ```bash pnpm install @@ -28,13 +39,13 @@ pnpm typecheck pnpm test ``` -## 3. Data and Credentials Workflow +## 4. Data and Credentials Workflow - Default data dir: `~/.super-multica` (override with `SMC_DATA_DIR`) - Credentials: `~/.super-multica/credentials.json5` (override with `SMC_CREDENTIALS_PATH`) - Initialize credentials via `pnpm multica credentials init` -## 4. Coding Rules +## 5. Coding Rules - TypeScript strict mode is enabled; keep types explicit. - Keep comments in code **English only**. @@ -42,14 +53,14 @@ pnpm test - Avoid broad refactors unless required by the task. - Keep docs concise and aligned with current code behavior. -## 5. Testing Rules +## 6. Testing Rules - Test runner: Vitest. - Mock policy: mock external/third-party dependencies only. - Do not mock internal modules when real integration can be tested. - Prefer temp directories and real file I/O for storage-related tests. -## 6. Commit Rules +## 7. Commit Rules - Use atomic commits grouped by logical intent. - Conventional format: @@ -60,14 +71,14 @@ pnpm test - `test(scope): ...` - `chore(scope): ...` -## 7. Minimum Pre-Push Checks +## 8. Minimum Pre-Push Checks ```bash pnpm typecheck pnpm test ``` -## 8. E2E Process Docs +## 9. E2E Process Docs - `docs/e2e-testing-guide.md` - `docs/e2e-finance-benchmark.md` diff --git a/README.md b/README.md index bf98fbe5..f882b42f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ # Super Multica +Super Multica is a distributed AI agent framework and product monorepo. +It provides a local-first agent runtime plus CLI, gateway, web, and mobile integration surfaces. + +What this project does: + +- runs AI agent sessions with tools, skills, and persistent session state +- supports scheduled/automated execution workflows +- supports both standalone local usage and remote-access client workflows + This repository keeps docs focused on: 1. Development workflow 2. Testing workflow 3. Operational process -Architecture and project-description details are intentionally omitted from docs. -Use source code as the architecture reference. +Architecture details are still source-of-truth in code, but docs keep minimal project context for onboarding. ## Quick Start (Workflow)