@elyx-design/cli

中文文档
0.0.1-preview.18273.g1dbfdb598f发布于 2026/11/17SEE LICENSE IN LICENSEES Module近 30 天下载 7402

Elyx 的命令行工具

中文使用文档
文档目录9 节
  1. 安装
  2. 打开工程
  3. 平台软件包
  4. 链接
  5. 窗口
  6. 项目依赖性
  7. 依赖性解决
  8. 图层目标
  9. 图像导入

@elyx-design/cli (英语)

Elyx项目、文件和云服务的命令行工具.

安装

npm install --global @elyx-design/cli
elyx --help

打开工程

在匹配中打开当前目录或另一个工程文件夹 Elyx 应用发布 :

elyx .
elyx /path/to/project

打开一个项目需要Elyx桌面应用. 本地文档命令没有 需要签名。 运行 elyx --help 以列表命令,以及 elyx <command> --help 对于命令的选项.

平台软件包

@elyx-design/cli 提供 JavaScript 发射器和捆绑道具 分析师。 npm 为您的操作系统安装匹配的可选软件包,并且 CPU 架构, 名称 @elyx-design/cli-<platform>-<architecture>该 软件包供应本地 elyx 可执行文件; 发射器转发您的 参数和退出状态.

安装时保持可选的依赖性 。 如果发射装置报告 缺少平台软件包, 包含可选的依赖性 :

npm install --global --include=optional @elyx-design/cli

链接

Linux支持x86-64和arm64(arch64)系统使用glibc. 乌邦图24.04 必须安装 Fontconfig 和 libcurl 。 这个 可执行嵌入 libc++, 所以系统的 libc++ 版本无关紧要。 阿尔卑斯山 目前不支持基于musl的其他分布.

窗口

Windows支持x64系统. 它的平台包保存了斯基亚的ICU数据, icudtl.dat,旁边 elyx.exe 用于文本布局。 把这些文件放在一起.

项目依赖性

在工程中声明复制的依赖性 elyx.json。没有 方案仍指可编辑的工作空间成员.

{
  "dependencies": {
    "theme": "path:../theme",
    "icons": "git+https://example.com/design/icons#^1.0.0",
    "tokens": "git+ssh://[email protected]/design/tokens#main",
    "components": {
      "git": {
        "url": "[email protected]:design/components.git",
        "ref": "~2.1.0"
      },
      "override": true
    },
    "brand": { "path": "../brand" }
  }
}

密钥是导入名 : icons 进口额 @icons/colors.elyx属性 依赖性使用 git+<url>#<ref> 或者说 {"git": {"url", "ref"}}时 url 可能 留着 git+ 前缀。 裸体 git://host/repo#ref 也使用Git软件 本土交通. 裁判从 ^, (中文(简体) ), ~,或 = 是一个闪存范围; 任何其它名称的标签,分支, 或全部承诺 HEAD路径 依赖性使用 path:<path> 或者说 {"path": "<path>"},相对于 宣布项目或绝对.

一个 Git 软件包由它的 URL 小写主机和路径识别, 不 方案、用户、端口或 .git这样 https://example.com/design/icons.git 财务报告和审定财务报表 [email protected]:design/icons 是一个包裹。 Git URL 必须是远程的; 声明 本地报到 path:。获取的项目选择每个软件包的 URL, 否则第一个看到胜利者; 获取验证承诺的ID, 因此 URL 永远不会 更改快照。 Git 随用户证书和 SSH 运行 配置,带有字面参数而无外壳.

"override": true 使吉特声明成为对其一揽子方案的唯一要求, 代替一切记录。 仅获取的项目 他们必须同意一个软件包的功能.

elyx deps fetch
elyx deps update
elyx --workspace /path/to/project deps fetch

命令使用当前文件夹中的正常工程发现或 --workspace。 。 。 . 工作空间让其成员一起决定并保持 elyx.lock 财务报告和审定财务报表 elyx_deps/ 除了工作空间表. fetch 把承诺固定在 elyx.lock 并且只解决新的依赖; update 解决每个 Git 依赖性 再来一次 两个都刷新路径副本. 吉特只用于吉特依赖.

解决办法是过渡性的,在冲突之间是倒退的. git ls-remote 列表 HEAD 和不下载对象的标签; 需要查询的分支, 因此锁只记录了分支声明名称. 版本来自标签 拼写准确 v<major>.<minor>.<patch>· ; =1.2.0 匹配标签 v1.2.0A级 作为标记而存在的名称是标记,否则是一个分支; refs/heads/name 总是命名分支。 单枪匹马抓进候选人 (单位:千美元)--depth=1 --no-tags因此服务器必须允许获取 身份证明 仓库需要一个项目 elyx.json 候选人 其清单被遗漏或无效。 Git 软件包可能使用相对 在他们自己的承诺范围内的路径依赖。 具有工作空间的存储器和 子模块尚未支持.

安装进入稳定状态 elyx_deps/ 由该目录的 SHA-256 命名文件夹 锁相源路径( q)path-),Git身份与承诺(git-),或 两者都加上存储路径(git-path-) (中文(简体) ). elyx.lock 记录依赖性 边缘,源,文件夹,被绑定的 承诺,以及每个承诺的校对和版本,所以 可以不与远程联系而检查声明。 本地路径在其中 锁相相. 提交 elyx.lock 忽略 elyx_deps/;新项目除外 并默认地忽视它。 安装完成并备份,所以故障离开 之前的锁和复制件已就位,并且锁被用解剖法写出。 一个 elyx_deps/.busy 文件夹块并行命令; 崩溃后, 删除 一旦没有命令运行.

副本遵循项目的索引编制规则(files.exclude、 资产和字体 包括嵌入式项目边界,始终保留根 elyx.json,省略 .git, (中文(简体) ), elyx_deps,以及 elyx.lock,并且只读。 正在装入工程 以中转方式将其安装的依赖性索引为只读项目,通过 elyx.lock; 缺失的或 steal 锁或副本会产生诊断指向 elyx deps fetch 或者说 elyx deps update无外部依赖的项目 不需要锁.

工作开始时会打印进度, 没有颜色 :

* Resolving github.com/acme/icons
* Getting github.com/acme/icons v1.4.0 (a1b2c3d4e5f6)
* Skipping github.com/acme/icons v1.5.0 (0f1e2d3c4b5a): No elyx.json in the repository root
* Overriding github.com/acme/tokens ^1.0 from github.com/acme/icons v1.4.0 (a1b2c3d4e5f6) with main
* Copying theme (path: ../theme)

Getting 命名匹配的版本或参考;锁定的获取跳过发现.

依赖性解决

依赖性版本范围跟随 npm 的语法数字 : =1.2.3 准确的说, ~1.2.3 保留在下面 1.3.0,以及 ^1.2.3 下级 2.0.0。 。 。 . Caret保留第一个非零成分: ^0.2.3 保留在下面 0.3.0 财务报告和审定财务报表 ^0.0.3 下级 0.0.4两者接受两个组成部分: ~1.2 < 1.3.0, (中文(简体) ), ^1.2 < 2.0.0, (中文(简体) ), ^0.0 < 0.1.0。只有稳定版本,每个数字最多14位 支持组件; 预放、构建元数据、其他操作员、大院 范围,和埃克西尔的 ~> 财务报告和审定财务报表 == 拒绝.

图层目标

elyx render 遵循输入文件 file {draw-connections: .true} 设置 当绘制连接箭头时。 绘制图层时 --ref,仅限 该层中的连接出现。 过 --no-connections 删除 来自 PNG 的箭头而不修改文件 .

elyx find 按精确引用查找地层( e)--ref),最顶层在 a 板- 空格点( o)--at X,Y),或矩形内的分层 (单位:千美元)--in X,Y,W,H),并返回其几何形状为 a results 阵列. elyx tree 返回一层的已解析层树(--ref或,无其中之一 档案板。 两者都呼应他们的意见: find 下级 query,以及 tree 作为 ref 财务报告和审定财务报表 depth (单位:千美元)"shallow", (中文(简体) ), "full",或实例预算).

通过每个点或矩形作为一个逗号分隔的参数,例如 --at "420,180" 或者说 --in "0,0,800,600"。引文对这些数值是可选的. elyx find 需要此表单并拒绝单独提供的坐标 数相辩相. 负协调工作 --at=-10,20 或者说 --at "-10,20"。 。 。 .

每个发现结果和树节点带一个 target 包含 filePath, (中文(简体) ), sourceRef,以及 overridePath; 无效目标表示运行时层没有 可重复使用的源地址 。 其他领域,例如: symbol, (中文(简体) ), ref,以及 path 描述地层,而不是识别确切的实例.

树节点还带有地层 doc 页:1 meta 映射, 或无效 缺席. meta 值保持其Elyx类型(字符串、数字或布尔),以及 实例报告 meta 他们继承了他们的来源.

与设计符号绑定的值为 {"value": …, "token": "<file>#<group>.<member>"} 而不是纯值. 符号名称为无上下文声明,所以在每句 --context时 value 在选择树报告时解决 contexts规模和制约因素 "auto" 用于拥抱内容, 数字 固定价值, "N%" 对于相对值,当未设定时无效.

使用目标的文件路径作为 CLI 输入, sourceRef 作为 --ref,以及 overridePath 作为 --override-path。例如:

elyx tree screen.elyx --ref=musicPlayer.track.save
elyx find screen.elyx --ref=card
elyx render screen.elyx --ref=card -o card.png

后代,副本 sourceRef 财务报告和审定财务报表 overridePath 从目标返回 寻找或树而不解释它们。 模糊的来源引用失败 选择实例。 在 MCP 中,通过返回对象为 select.target 改为 elyx_find, (中文(简体) ), root.target 改为 elyx_tree, (中文(简体) ), target 或进入 焦点 targets 阵列。 点和矩形 发现和全文件树 filePath为制作整份文件,请通过 target: {filePath: "screen.elyx"}。 。 。 .

elyx css 为一层写一个样式表( t)--ref)或董事会:一个类别 以它命名,并成为独一无二的。 每条规则从 层本身的样式:大小,布局,填充,边框,阴影和打字. 礛 从树上走过来的部分 堆放与瑜伽相匹配的物品,所以不会 收缩,和 100% 大小填充堆栈。 堆栈外的层是绝对的 定位于他们的作者边缘。 滑行框隐藏溢出. display: .none 层被忽略。 根没有位置,所以可以 放置在任何地方.

键值为 var(--<prefix>-<scope>-<token>, <value>),命名为 vite-plugin-elyx 符号样式表;通过样式表的前缀 --prefix (默认) elyx) (中文(简体) ). 图像从路径中填充相对于工作目录的负载. --format json 返回样式表为 css 加一个 rules 数组; 每个规则 拥有 className,命令 declarations层 target。 。 。 .

elyx css screen.elyx --ref=card --prefix=ms

图像导入

对于 elyx fig inspect, (中文(简体) ), elyx fig convert,以及支持的相片特征, 见 图像支持矩阵。 。 。 .

版本与发布记录

@elyx-design/cli 共发布 176 个版本,首次发布于 2026/07/15;过去 12 个月发布了 176 个版本。

版本发布日期距今
0.0.1-preview.18273.g1dbfdb598flatest2026/11/17今天
0.0.1-nightly.18264.g9146e24ca1nightly2026/11/17今天
0.0.1-nightly.18188.g5b1039048a2026/11/161 天前
0.0.1-nightly.18172.g09123d2f002026/11/152 天前
0.0.1-nightly.18159.g4b9674390d2026/11/152 天前
0.0.1-nightly.17997.g94b41aee232026/11/134 天前

其他发布通道:bootstrap → 0.0.0-bootstrap.0,preview → 0.0.1-preview.15345.gd9409cf06,nightly → 0.0.1-nightly.18264.g9146e24ca1。

关于 @elyx-design/cli 的常见问题

@elyx-design/cli 是什么?

Elyx 的命令行工具

如何安装 @elyx-design/cli?

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

@elyx-design/cli 支持 TypeScript 吗?

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

@elyx-design/cli 支持 ESM 还是 CommonJS?

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

@elyx-design/cli 可以商用吗?

@elyx-design/cli 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@elyx-design/cli 的下载量有多少?

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

@elyx-design/cli 还在维护吗?

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