Skip to content

命令行工具(CLI)

Virmath Elf CLI 是虚数精灵编辑器(Virmath Elf Editor)自带的命令行工具,主要提供以下能力:

  • 将本机鼠标位置通过 UDP 实时发送到指定地址(mps);
  • 通过编辑器管理程序,包括对程序、节点、选项和连接进行增删改查(program);
  • 在不启动编辑器的情况下查看本地规则文档(program docs)。

基本要求

  • 使用 CLI 管理程序等功能前,请先启动虚数精灵编辑器。若编辑器未运行,CLI 会提示:

    text
    无法连接到虚数精灵编辑器(Virmath Elf Editor),请确认编辑器已启动

获取与运行

安装虚数精灵编辑器后,即可在终端(命令提示符或 PowerShell)中直接使用 elf 命令,Windows 下也可以使用 elf.exe

面向 AI Agent

Virmath Elf CLI 主要为 AI Agent(智能体) 设计,方便 Agent 通过命令行直接与编辑器交互:查询或创建程序、节点、选项与连接,以及查看本地规则文档。查询类命令以 JSON 格式输出,错误信息输出到标准错误,便于程序解析。

示例 Prompt

以下 Prompt 可作为 AI Agent 使用该 CLI 的起点:

text
你是一个桌面自动化助手。虚数精灵编辑器已在本机运行,你可以使用命令行工具 elf 与其交互。

1. 先用 `elf --help` 查看可用命令;需要时再用 `elf program --help`、`elf program node --help` 等查看子命令参数。
2. 查询类命令会输出 JSON,可直接解析。例如,要列出当前所有程序的名称,执行 `elf program list` 并读取结果中的 `programs` 字段。
3. 创建新程序:`elf program add --name "程序名"`。`elf program docs --help` 可查看不依赖编辑器的本地规则文档主题。
4. 命令执行失败时,根据错误提示修正参数后重试;若提示无法连接到编辑器,请提醒用户先启动编辑器。

通用选项

选项说明
-h, --help打印帮助信息
-V, --version打印版本号

命令总览

text
elf
├── mps                  鼠标位置发送器
└── program              程序相关子命令
    ├── list             列出所有程序
    ├── add              添加程序
    ├── delete           删除程序
    ├── set              修改程序
    ├── node             程序节点相关子命令
    │   ├── list         列出程序的所有节点
    │   ├── get          获取节点详细信息
    │   ├── add          添加节点
    │   ├── types        浏览节点类型分类
    │   ├── docs         查看节点文档
    │   ├── delete       删除程序中的节点
    │   └── connector    节点连接器相关子命令
    │       ├── set      设置连接器值
    │       ├── add      增加节点连接器(一次一组)
    │       └── delete   删除节点连接器(一次一组)
    ├── option           程序选项相关子命令
    │   ├── list         列出程序的所有选项
    │   ├── add          添加程序选项
    │   ├── delete       删除程序选项
    │   └── set          修改程序选项
    ├── connection       程序连接相关子命令
    │   ├── add          创建节点间连接
    │   └── delete       删除节点间连接
    └── docs             查看程序文档(本地文档,无需编辑器)

mps 会持续运行并发送鼠标位置,直到按 Ctrl + C 停止。