Maka 开始进行 release 之前的全面梳理了！！

并且开始全面的梳理 设计文档 了，对想学习和了解 Agent的开发的人，绝对能够从这部分学到很多东西。欢迎大家阅读！

Maka 现在 640 ，3个 Maintainer，22 contributor，群里每天都有很热烈的讨论。 非常感谢大家的贡献。

另外也感谢大家对一个还没有release的项目就有这么多关注了，欢迎大家star，后续还在继续迭代中。

https://github.com/maka-agent/maka-agent…

maka-agent/maka-agent

Source: https://github.com/maka-agent/maka-agent

中文

Maka

A local-first Agent workspace built for real work.

Maka does more than answer questions. With controlled permissions, it can inspect projects, execute tools, produce artifacts, and preserve model messages, tool calls, and durable-task progress as recoverable execution facts. The same Runtime is available through the desktop app, terminal TUI, non-interactive CLI, and Headless runner.

Maka is under active development and currently targets users running from source or contributing to the project. Data formats, CLI commands, and experimental capabilities may still change.

Why Maka

• Local-first instead of hosted-first: sessions, settings, and run records stay on your machine by default. You choose the model connection: cloud API, local model, or compatible gateway.
• Log is the Runtime: model messages, Tool Calls, Tool Results, and termination facts enter Runtime Event Log. Sessions, UI, model context, and recovery are projections over that log.
• Context is not history: Tool Result pruning and LLM Compaction change what the next inference sees without treating recorded evidence as disposable context.
• A task may outlive a Turn: Headless uses TaskRun, Task Event Log, budgets, and continuation to advance interruptible and inspectable durable work.
• Feedback is not fact authority: Self-check may produce evidence and one bounded repair opportunity, but “I checked it” does not become a system fact.

Read Maka Backend Architecture for the complete design.

Surfaces

Current capabilities

Agent Runtime

• Multiple model connections, streaming output, thinking, usage accounting, and provider-error normalization;
• Local tools including Read, Write, Edit, Bash, Glob, and Grep;
• Tool schema validation, dynamic availability, permission policy, watchdogs, abort, and error classification;
• Runtime Event Log, AgentRun ledger, startup recovery, Turn Evidence, active Tool Result pruning, and history compaction.

Desktop workspace

• Create, archive, search, rename, retry, regenerate, and branch sessions from a Turn;
• Artifact lists and previews, workspace instructions, model settings, and permission settings;
• Local memory, web search, an open HTTP/SSE gateway, bot entry points, and Office workflows;
• Integrations are configured independently, and not every experimental entry is available by default.

Durable tasks and evolution

• Append-only Task Event Log and TaskRun projection;
• Budgets, permission pauses, continuation, result export, and failed-task retry;
• Plan-first, source-guarded, and attempt-bounded Heavy-task Self-check;
• AHE target protocol and evidence export; complete automatic self-iteration remains an external or experimental workflow.

Quick start

Requirements

• Node.js 22 (the current CI baseline);
• npm (the lockfile and scripts use npm; the current packageManager is npm 11);
• Git;
• ripgrep, used by Runtime’s Grep tool.

Start Desktop

git clone https://github.com/Maka-Agent/maka-agent.git
cd maka-agent
npm ci
npm run dev

npm run dev starts the Desktop development environment with HMR. To build every workspace before starting Electron, use:

npm run dev:full

If dependencies were installed with ELECTRON_SKIP_BINARY_DOWNLOAD=1, install the Electron platform binary before starting:

node node_modules/electron/install.js

First run

Maka does not bundle a shared model account. On first launch:

1. Open Settings → Models;
2. Add an API, local-model, or supported account connection;
3. Test it and choose a default model;
4. Return to the workspace and start a task.

The app distinguishes configured, send-ready, and experimental connection states. An account flow that is not wired into Runtime is not presented as a usable model.

Terminal entry points

Build the workspaces first:

npm run build

Then start the TUI or run one Turn:

npm --workspace maka-agent exec -- maka
npm --workspace maka-agent exec -- maka run "Summarize this repository and identify its most important risk"
npm --workspace maka-agent exec -- maka --help

The CLI reads the same model connections and workspace configuration written by Desktop. See packages/headless/README.md for Headless commands and its trust posture.

Architecture

The backend spine is:

Desktop / TUI / Headless
          ↓
SessionManager → AgentRun → Model + Tool Runtime
          ↓
Runtime Event Log → Context / Session / UI projections
          ↓
Task Event Log → TaskRun → Self-check / AHE evidence

Start with ARCHITECTURE.en.md. It provides the system map, code boundaries, problem-oriented reading paths, and six bilingual deep dives.

Repository layout

apps/desktop/       Electron main / preload / React renderer

packages/core/      Pure contracts for Sessions, Events, Permissions, and Connections
packages/storage/   File-backed stores and run ledgers
packages/runtime/   AgentRun, model adapters, tools, context, and recovery
packages/headless/  TaskRun, Autonomous Loop, Self-check, eval, and AHE
packages/cli/       TUI and non-interactive CLI
packages/ui/        Shared conversation, Markdown, Artifact, and UI primitives

docs/               Architecture, product, security, privacy, and test contracts
scripts/            Build hygiene, visual checks, smoke tests, and release helpers

Local data and security boundary

Maka stores workspace data under Electron userData by default:

<Electron userData>/workspaces/default/
  llm-connections.json
  credentials.json
  settings.json
  sessions/

Current boundaries that matter:

• Sessions and connection metadata live in the local filesystem;
• Runtime credentials such as API keys, bot tokens, and proxy passwords currently live in local plaintext credentials.json, behind the OS account boundary, with POSIX directory mode 0700 and file mode 0600 enforced;
• Supported subscription OAuth tokens use Electron safeStorage and fail closed when it is unavailable;
• Renderer does not receive plaintext credentials. File writes, Shell, and dangerous tool calls pass through the permission engine;
• Headless real-model evaluation fails closed by default and requires an explicit external isolation boundary.

Read SECURITY.md for security reporting and policy. Detailed privacy and threat-model documents live under docs/.

Development and verification

Common repository-level commands:

npm run build
npm run typecheck
npm test
npm run check:release

Run one workspace in isolation:

npm --workspace @maka/runtime test
npm --workspace @maka/headless test
npm --workspace @maka/desktop test

Desktop real-window and visual verification:

npm --workspace @maka/desktop run e2e
npm --workspace @maka/desktop run screenshots
npm --workspace @maka/desktop run screenshots:diff:stable
npm --workspace @maka/desktop run smoke:real-window

Before submitting code, run typecheck, build, and focused tests proportionate to the change, followed by git diff --check.

Documentation

• Backend architecture
• Headless usage and isolation
• Design system
• Full product test plan
• Workspace privacy context
• Capability maturity audit
• Security policy