@a-company/paradigm

中文文档
8.1.1发布于 2026/11/05MITTypeScriptES Module近 30 天下载 1888

Unified CLI for Paradigm developer tools

原始使用文档
文档目录8 节
  1. Why use it
  2. Install
  3. Gnomon (new in 8.0)
  4. The CLI and the MCP server
  5. Agents and skills
  6. Maintained alongside Paradigm
  7. Parked
  8. Links

Paradigm

Paradigm gives AI coding agents structure, deterministic checks and calibrated memory for your codebase.

  • Structure. Each part of your code is described in plain YAML next to the code: .purpose files for components, flows and signals, and portal.yaml for authorization gates. Agents get answers from this map through MCP tools instead of reading the whole repository.
  • Determinism. Shell hooks run at fixed points in a Claude Code or Cursor session. The Stop hook blocks the session when code changed but its .purpose file, gate or lore entry did not. The hooks are scripts, not instructions an agent can ignore.
  • Calibration. Agents keep notebooks, lore and decisions. A new learning is proposed, tested against scenarios and signed off by you before it reaches a notebook. Token estimates are rebuilt from measured usage (paradigm calibrate).

8.0 adds Gnomon, a local console for your Claude Code sessions on Apple silicon Macs.

Why use it

  • Agents stop rediscovering your codebase. They ask the map for the right files instead of reading everything, so sessions start faster and use fewer tokens.
  • Changes don't silently skip the paperwork. If an agent changes code without updating its description, gates or history, the session is blocked until it does.
  • Auth rules are written down. Protected routes and their gates live in portal.yaml, so agents check them before adding an endpoint.
  • Your project remembers why. Decisions, lore and agent notebooks survive between sessions, so the next agent knows what was tried and why.
  • A team of specialised agents. An architect, builder, reviewer, security agent and more, each with its own notebook, which improves as you approve what it learns.
  • One place to steer many sessions (Gnomon). Every permission, question and plan from your Claude Code sessions lands on one decision stack. You answer by click or keyboard, confirmed with Touch ID or your password, or by voice if you turn it on.

Good fits: a codebase that has outgrown one person's head, several agents working in parallel, auth-sensitive apps, and long-running projects where context gets lost between sessions.

Install

npm install -g @a-company/paradigm
cd your-project
paradigm shift

You need Node 24 or later. paradigm shift creates .paradigm/, a root .purpose, portal.yaml, instruction files for Claude Code, Cursor, Copilot and Windsurf, plus AGENTS.md, and the enforcement hooks. Running it again is safe: it never overwrites existing content.

If you use Claude Code, also install the plugin. It adds the hooks, skills, agents and the MCP server for every project:

/plugin marketplace add ascend42/a-paradigm
/plugin install paradigm@a-paradigm

Gnomon (new in 8.0)

Gnomon runs your Claude Code sessions on your Mac and asks you before anything that matters happens.

gnomon

The first run installs a signed and notarized Gnomon.app into /Applications, or into ~/Applications if you can't write to /Applications. It then opens setup. Setup asks for Touch ID or your password twice, then opens the desk. After an upgrade, quit and reopen Gnomon.

What you get:

  • The desk. One window for your sessions. When a session needs a decision (a permission, a question, a plan), it puts a card on the decision stack. You decide it there, and your answer is signed with a Secure Enclave key after Touch ID or your password. The unlock lasts until the screen locks.
  • Sandboxed sessions. Claude Code runs headless inside a macOS sandbox profile.
  • A hash-chained log. Every session event is chained, so later edits to the log show up.
  • A budget fuse. A spending limit that applies across all your sessions.
  • Mods. Panels that run as separate, sandboxed processes. The first-party set:
    • Workshop: what needs you and what is running.
    • Ledger: tokens, cache share, cost and budget.
    • Paradigm Context: open tasks, decisions and lore for the focused project.
    • Neurons and Constellation: optional, if you run those tools.
  • Voice. Speak to a session and hear short replies. Speech is processed on the Mac, and the audio never leaves it.

Requirements:

  • An Apple silicon Mac with macOS 15 or later and System Integrity Protection on. Intel Macs, Windows and Linux are not supported in 8.0.
  • Node 24 or later. Gnomon itself runs on its own pinned Node inside the app.
  • Claude Code from the native installer, signed in with your Claude subscription. Gnomon refuses API-key billing.
  • Touch ID or your login password.

Known limitation: the Mac helper doesn't yet check which program is calling it. Another program running as you could start it and ask it to sign, but every signature it makes still needs your Touch ID or password.

Design: docs/specs/gnomon.md.

The CLI and the MCP server

CommandWhat it does
paradigm shiftSet up or update a project
paradigm doctorHealth check, including hook timings
paradigm statusProject overview and symbol counts
paradigm ripple <symbol>What a change to a symbol affects
paradigm integrityBroken references, duplicates, orphans
paradigm sync <ide>Regenerate instruction files (claude, cursor, copilot, windsurf, agents)
paradigm scan autoDraft .purpose files from existing code
paradigm lintValidate .purpose files
paradigm hooks installReinstall the enforcement hooks
paradigm serveOpen Platform, the local web UI (lore, graph, Academy, Brain)
paradigm mcp setupAdd the MCP server to Cursor, Claude Desktop, Continue or Cline

paradigm --help lists every command. Read-only commands such as status, doctor and ripple make no writes and no network calls.

The package includes the MCP server as paradigm-mcp. It lists 32 tools by default (11 core tools and 21 grouped families such as paradigm_lore and paradigm_task). 13 more (Sentinel, Symphony, University and others) are switched on with paradigm_tool_activate or in .paradigm/config.yaml.

Five symbols name things across code, docs and commits: # component, $ flow, ^ gate, ! signal, ~ aspect.

Agents and skills

Paradigm bundles 68 agent profiles: architect, builder, reviewer, tester, security, designer and more. paradigm shift puts a default roster on your project. Manage it with paradigm agent roster, bench and activate.

  • Notebooks hold what each agent has learned (paradigm notebook).
  • Skills carry each agent's repeatable procedures, and they are what agents read at runtime (paradigm skill list). Agent behaviours in the profiles are not read at runtime.
  • For example, the designer agent ships its UI review and design-options protocols as skills, so they work in any project.

Maintained alongside Paradigm

  • Sentinel: incident tracking tied to your symbols (paradigm sentinel, sentinel-mcp).
  • University: content packs, quizzes and the PLSAT, shown in Platform's Academy (paradigm university).
  • Symphony: messages between Claude Code sessions (paradigm symphony).
  • Warpline (experimental): merge prediction from the symbol graph (@a-company/warpline).
  • Workspaces: shared symbols across related repos (paradigm workspace).
  • Brain: structure for a personal notes folder, private by default (paradigm brain).
  • Atelier, a separate product, works with Paradigm's designer agent.

Parked

These still exist in the repository but get no active work:

  • Conductor, the SwiftUI session overlay. It builds only from a repository clone.
  • The VS Code extension.
  • sentinel-rs, sentinel-web, paradigm-runtime and the Warpline GitHub Action.
  • The standalone portal-*, purpose-core, premise-core and probe-core npm packages. Paradigm bundles its own copies, and the npm versions are out of date.

版本与发布记录

@a-company/paradigm 共发布 122 个版本,首次发布于 2026/02/21;过去 12 个月发布了 122 个版本。

版本发布日期距今
8.1.1latest2026/11/053 天前
8.1.02026/10/2910 天前
8.0.42026/10/2811 天前
8.0.32026/10/2613 天前
8.0.22026/10/2514 天前
7.15.2release-72026/10/2316 天前

关于 @a-company/paradigm 的常见问题

@a-company/paradigm 是什么?

Unified CLI for Paradigm developer tools

如何安装 @a-company/paradigm?

在项目目录运行 npm install @a-company/paradigm,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gnomon、paradigm、sentinel、paradigm-mcp、sentinel-mcp,可以用 npx gnomon 直接运行。

@a-company/paradigm 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@a-company/paradigm 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@a-company/paradigm 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@a-company/paradigm 可以商用吗?

@a-company/paradigm 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@a-company/paradigm 的下载量有多少?

根据 npm 官方下载统计,@a-company/paradigm 在 2026/10/05 – 2026/11/03 这 30 天内被下载 1,888 次,日均约 63 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@a-company/paradigm 还在维护吗?

最新版本 8.1.1 发布于 2026/11/05(3 天前);至今共发布 122 个版本,其中过去 12 个月发布了 122 个;首次发布于 2026/02/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。