axonometric

中文文档
0.1.0发布于 2026/11/03MITES Module零依赖构建来源已验证

Editable architecture maps built with an AI agent

原始使用文档
文档目录3 节
  1. Install
  2. Instructions for your agent
  3. License

axonometric

Interactive architecture maps you build with an AI agent. The agent writes a map of a system from its code and docs. You walk through it chapter by chapter, present it to your team as one diagram, and edit it in the browser. Your edits go back to the agent as proposals, which it accepts or argues against.

Status: in development, with no release yet. The plan is #1.

The design is inspired by inkboard/system-atlas.

Install

There are three ways to install it. The npm package and the binaries arrive with the first release.

With Node 24.22.1 or newer, install the npm package:

npm install -g axonometric

Without Node, install a standalone binary from GitHub Releases. Each binary has Node built in. The install script picks the binary for your OS and architecture, checks it against the release's SHA256SUMS, and puts it in ~/.local/bin:

curl -fsSL https://github.com/mippbipp/axonometric/releases/latest/download/install.sh | sh

On Windows, in PowerShell, this installs to %LOCALAPPDATA%\Programs\axonometric:

irm https://github.com/mippbipp/axonometric/releases/latest/download/install.ps1 | iex

Set AXONOMETRIC_VERSION (for example 0.1.0) to install a version other than the latest, or AXONOMETRIC_INSTALL_DIR to install somewhere else. Binaries exist for Linux x64 and arm64 (glibc only), macOS x64 and arm64, and Windows x64.

The macOS binaries have an ad-hoc signature and aren't notarized. If you download a macOS archive in a browser, macOS quarantines the binary and refuses to open it. Clear that with xattr -d com.apple.quarantine <path to axonometric>. The install script downloads with curl, which doesn't set the quarantine. The Windows binary isn't signed, so SmartScreen may warn the first time you run it.

With Nix, run it straight from the flake with nix run github:mippbipp/axonometric -- --help, or add github:mippbipp/axonometric as a flake input and install packages.<system>.default.

Instructions for your agent

axonometric docs prints the guide an agent follows to build and review a map. It lists the topics, and axonometric docs <topic> prints one: process, data, chapters, design, review and visual-check. The guide is bundled in the CLI, so it works offline and always matches the installed version.

Install the skill so your agent knows when to use the CLI:

npx skills add mippbipp/axonometric

This installs one folder, skills/axonometric/, which holds a SKILL.md. The skill triggers on requests to map, explain, review or present a system's architecture, and on the review prompt that the page copies. It tells the agent to run axonometric docs first. The CLI itself must be on the agent's PATH, or reachable with npx axonometric. The skill says how to install it if not.

License

MIT

版本与发布记录

axonometric 共发布 3 个版本,首次发布于 2026/11/01;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.0latest2026/11/03今天
0.0.02026/11/012 天前
0.0.0-stage2026/11/012 天前

关于 axonometric 的常见问题

axonometric 是什么?

使用AI代理构建的可编辑架构地图

如何安装 axonometric?

在项目目录运行 npm install axonometric,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 axonometric,可以用 npx axonometric 直接运行。

axonometric 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/axonometric 是否存在。

axonometric 支持 ESM 还是 CommonJS?

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

axonometric 需要什么版本的 Node.js?

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

axonometric 可以商用吗?

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

axonometric 还在维护吗?

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