面向AI的极简输出协议：Ix --format llm格式深度解析

面向AI的极简输出协议Ix --format llm格式深度解析【免费下载链接】IxUnderstand any codebase instantly. System intelligence for codebases, built for humans and AI.项目地址: https://gitcode.com/gh_mirrors/ix8/IxIx 是一款面向代码库的系统智能命令行工具它用 tree-sitter 解析 26 种语言把整个仓库构建成可查询的符号图谱让开发者与 AI 助手都能瞬间理解任何代码库。而--format llm正是 Ix 专为 AI 编程助手Claude、Cursor、Codex 等设计的极简输出协议——它把每次查询结果压缩成一行一记录的紧凑格式通常比 JSON 输出节省2-4 倍 token。本文带你深度解析这套协议的设计思想、语法规则与实战用法。为什么 AI 编程助手需要一套专门的输出格式AI 助手在一次会话中会调用ix几十上百次每次返回的文本都要计入上下文窗口。传统的两种格式各有短板格式优点致命伤--format text人类可读、有装饰空白缩进、彩色符号全是无效 token--format json结构完备、可解析括号、引号、键名重复开销巨大--format llm极简、省 token不适合人类阅读本来就是给模型看的在树形和表格类输出上--format llm比json平均减少 2-4 倍字节。这意味着同样的上下文窗口AI 能读到 4 倍的信息量。Ix llm格式的三大设计原则这套格式的完整规范写在 docs/llm-format.md核心设计只有三条一行一条记录换行分隔绝不嵌套天然抗截断keyvalue扁平键值标量用空格分隔表格行用记录类型 键值对丢掉所有装饰没有表头、没有分隔线、没有缩进llm输出格式语法规则详解1. 标量与记录行标量就是空格分隔的keyvalue对比如ix stats的输出nodes total98979 method49180 module38199 class6833 file3285表格类输出前面会加一个记录类型标记比如ix subsystems --listregion idcli-client labelCli / Client kindsubsystem level2 files872. 空值直接省略null、undefined和空字符串一律不输出——没有的东西就不占 token。0 和默认值如果没有信息量也会被丢弃。3. 值含特殊字符时自动加引号一旦值里出现空格、、、\或控制字符就用双引号包裹内部转义\n、\r、\t。这保证了一条记录永远不会跨行消费端可以放心按行切分。4. 错误也是统一格式出错时输出一行error记录进程仍以非零码退出error codeunknown_target messageNo entity named IngestionService foundAI 助手解析这一行就能判断失败原因无需读取 stderr。树形数据如何用一行行记录表达层级结构比如ix map的 region 树会被拍平成扁平记录用显式的parentid字段表达父子关系region idroot kindsystem labelCli region idcli kindsubsystem labelClient parentroot region idsrv kindsubsystem labelServer parentroot消费端只凭id和parent就能重建整棵树。这个设计妙在两点保持无缩进不变量而且即使输出被管道截断每一条记录依然独立成立。实战explain 命令的 llm 格式输出explain是 AI 插件调用最频繁的命令它的 prose 渲染解释、上下文、重要性是最耗 token 的部分。Ix 的做法是prose 本来就是事实的渲染直接输出事实本身让模型自己总结。entity idverify_token nameverify_token kindfunction pathsrc/auth.ts rev3 role rolevalidator confidence0.92 importance levelhigh categoryboundary edges callers14 callees3 dependents5 importers2 members0 downstream9 depth3 history12对比原来的散文式输出这套记录大约缩小55%。实现代码见 ix-cli/src/cli/explain/llm.ts。llm格式的设计例外read 与 status设计者留下了两个故意不遵守规则的例外非常值得玩味read的正文不是记录AI 要源码就要逐字节的源码所以正文原样输出前面加一行content linesn让数据块自定界——这是唯一放宽一行一记录的地方。status并不更小它只有几个标量大小和 JSON 差不多。但它提供了显式的staletrue|false字段这正是 AI 最想知道的问题答案。哪些命令支持 --format llm所有接受--format的命令都接受llm共分五个层级逐步覆盖Tier 1map、subsystems、impact、smells、overview、statsTier 2inventory、rank、depends、trace、contains、callers、callees、imports、imported-byTier 3search、text、history、patchesTier 4entity、locate、diff、conflictsTier 5explain、read、status、doctor、savings没有专属渲染器的命令会自动路由到最紧凑的既有格式通常是text所以消费端可以无条件传--format llm无需逐命令查表。所有渲染逻辑集中在 ix-cli/src/cli/llm.ts。快速上手让 AI 助手用上 llm 格式安装 Ix按官方脚本安装 CLI仓库内置安装脚本在 scripts/install/支持 sh、ps1、cmd构建图谱进入项目目录运行ix map .给 AI 插件配置格式在 Claude、Cursor 等工具的 Ix 插件配置中指定--format llm或在命令末尾直接追加开始提问ix impact verify_token --format llm、ix callers parseFile --format llm总结--format llm是 Ix 送给 AI 编程生态的一份极简礼物它不追求面面俱到而是精准回答一个问题——如何用最少的 token 传递最完整的结构信息。对于正在搭建 AI 编码工作流的开发者这套协议值得直接借鉴对于普通用户只要记住一句话想让 AI 助手更省钱更聪明就在 Ix 命令后面加上--format llm。【免费下载链接】IxUnderstand any codebase instantly. System intelligence for codebases, built for humans and AI.项目地址: https://gitcode.com/gh_mirrors/ix8/Ix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考