Jiayuan Zhang 18a6996c97 docs: slim down README and split into topic-specific docs

Add local full-stack development section (pnpm dev:local) and
move detailed content (credentials, CLI, skills/tools, time
injection, development guide) into separate docs/ files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-15 03:23:54 +08:00

3 KiB

Raw Blame History

Super Multica

Multiplexed Information & Computing Agent

An always-on AI agent that pulls real data, runs real computation, and takes real action — monitoring, analyzing, and acting within user-defined authorization boundaries.

See Memo for product vision, architecture, and roadmap.

Project Structure

apps/
├── cli/           # Command-line interface
├── desktop/       # Electron desktop app (recommended)
├── gateway/       # NestJS WebSocket gateway
├── server/        # NestJS REST API server
├── web/           # Next.js web app
└── mobile/        # React Native mobile app

packages/
├── core/          # Agent engine, hub, channels
├── sdk/           # Gateway client SDK
├── ui/            # Shared UI components (Shadcn/Tailwind v4)
├── store/         # Zustand state management
├── hooks/         # React hooks
├── types/         # Shared TypeScript types
└── utils/         # Utility functions

skills/            # Bundled agent skills

Quick Start

pnpm install

Development

pnpm dev              # Desktop app (standalone, no Gateway needed)
pnpm dev:gateway      # Gateway only
pnpm dev:web          # Web app only
pnpm dev:all          # Gateway + Web

Local Full-Stack Development

pnpm dev:local starts the entire stack locally (Gateway + Desktop + Web) with isolated data directories, useful for end-to-end development and testing.

Setup:

Copy .env.example to .env at the repo root
Fill in TELEGRAM_BOT_TOKEN (get from @BotFather)
Run pnpm dev:local

What it starts:

Service	Address	Notes
Gateway	`http://localhost:4000`	Telegram long-polling mode
Web	`http://localhost:3000`	OAuth login flow
Desktop	—	Connects to local Gateway + Web

Data isolation: All data goes to ~/.super-multica-dev and ~/Documents/Multica-dev, separate from production ~/.super-multica.

Related commands:

pnpm dev:local:archive    # Archive dev data and start fresh

Architecture

Desktop App (standalone, recommended)
  └─ Hub (embedded)
     └─ Agent Engine

Web/Mobile Clients
  → Gateway (WebSocket, :3000)
    → Hub
      → Agent Engine

Desktop App: Electron app with embedded Hub, no Gateway needed
Gateway: WebSocket server for remote clients
Hub: Agent lifecycle and event distribution

Documentation

Topic	Link
Development guide	docs/development.md
Credentials & LLM providers	docs/credentials.md
CLI usage	docs/cli.md
Skills & tools	docs/skills-and-tools.md
Time injection design	docs/time-injection.md
Package management	docs/package-management.md

3 KiB Raw Blame History