Skip to content

安装

Node 版本要求

自定义组件开发工具(neo-cmp-cli)需要 Node.js v16 或更高版本 (推荐 v20 以上)。可以使用 nnvmnvm-windows 在同一台电脑中管理多个 Node 版本。

可以使用下列任一命令安装自定义组件开发工具(neo-cmp-cli):

bash
yarn global add neo-cmp-cli --registry https://registry.npmmirror.com
# 或
npm i -g neo-cmp-cli --registry=https://registry.npmmirror.com

安装之后,就可以在命令行中访问 neo 命令。可以通过简单运行 neo -h,看看是否展示出了一份所有可用命令的帮助信息,来验证它是否安装成功。

还可以用这个命令来检查其版本是否正确:

bash
neo --version

升级

如需升级全局的自定义组件开发工具(neo-cmp-cli),请运行:

bash
npm update -g neo-cmp-cli

# 或者
yarn global upgrade --latest neo-cmp-cli

CLI 安装相关常见问题

Q1:在 Windows 的 VS Code 终端中执行 neo 相关命令报错

A:若提示「在此系统上禁止运行脚本」,多为 PowerShell 执行策略限制。可在当前用户范围放宽策略(需自行评估安全策略是否适用):

powershell
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser

说明:上述命令允许当前用户在 Windows 上执行脚本。更多背景见 Microsoft 文档:about_Execution_Policies

Q2:提示「无法将“neo”项识别为 cmdlet、函数、脚本文件或可运行程序的名称」

A:多为 PATH 未包含 npm 全局可执行文件目录。可按下面步骤将 npm 全局路径加入 PATH(PowerShell 示例):

步骤 1:查看 npm 全局前缀路径

powershell
$npmPath = npm config get prefix

步骤 2:将路径加入当前会话的 PATH(立即生效)

powershell
$env:PATH += ";$npmPath"

步骤 3:写入用户级环境变量(新开终端仍生效)

powershell
[Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";$npmPath", "User")

说明:若安装 Node.js 时未勾选安装必要工具等选项,也可能导致全局命令不可用;请结合本机安装方式排查。