概述

GenAIScript CLI genaiscript 可以在Visual Studio之外以及您的自动化流程中运行GenAIScript脚本。

npx genaiscript ...

pnpx genaiscript ...

yarn dlx genaiscript ...

先决条件

CLI是一个托管在npm上的Node.JS包。

• 安装 Node.JS LTS (Node.JS 包含 npm 和 npx)。

安装

• 在您的项目中作为devDependency本地安装。

npm i -D genaiscript

pnpm add -D genaiscript

yarn add -D genaiscript

• 全局安装它。

npm install -g genaiscript

• 通过运行以下命令检查您的node版本是否至少为20._且npm版本为10._。

node -v
npx -v

v20.11.1
10.5.0

无需安装 (npx)

npx 随 Node.JS 一起安装。

使用npx， 您无需任何预先安装步骤即可运行命令行界面。 npx会按需安装该工具。npx还能解决操作系统路径中找不到工具这类棘手问题。

npx genaiscript ...

• 添加 --yes 以跳过确认提示，这在 CI 场景中很有用。

npx --yes genaiscript ...

• 指定版本范围以避免使用npx安装的CLI缓存版本导致意外行为。

npx --yes genaiscript@^1.16.0 ...

辅助脚本

为确保TypeScript定义文件被正确写入和更新，您可以将以下脚本添加到您的package.json中。

{
    "scripts": {
        "postinstall": "genaiscript scripts fix",
        "postupdate": "genaiscript scripts fix",
        "genaiscript": "genaiscript"
    }
}

genaiscript 也是一个简写脚本，可以更轻松地通过 npm run 来调用 CLI：

npm run genaiscript ...

在代理服务器后工作

CLI使用的一些可选包不支持在HTTP代理后安装，这在企业环境中非常常见。

如果您的工作环境需要通过代理，您应该使用npm install --omit=optional以便在安装过程中可选包能够优雅地失败。

如果您的工作环境需要通过代理服务器， 可以设置以下任一环境变量 (HTTP_PROXY, HTTPS_PROXY, http_proxy 或 https_proxy) 来让CLI使用代理， 例如 HTTP_PROXY=http://proxy.acme.com:3128。

配置

CLI将从环境变量或./.env文件中加载secrets。

您可以通过添加--env .env.local文件来覆盖默认的.env文件名，甚至可以同时导入这两个文件。

npx genaiscript run <script> --env .env .env.local

创建新脚本

在genaisrc文件夹中创建一个新的脚本文件。

npx genaiscript scripts create <name>

编译脚本

运行TypeScript编译器来查找脚本中的错误。

npx genaiscript scripts compile

运行脚本

Run a script 在文件上运行脚本 并将LLM输出流式传输到标准输出。请从工作区根目录运行。

npx genaiscript run <script> [files...]

其中

CLI 还支持 UNIX 风格的管道操作。

cat README.md | genaiscript run summarize > summary.md

列出模型配置

运行script model命令以列出可用脚本及其模型配置。这有助于诊断CI/CD环境中的配置问题。

npx genaiscript scripts model [script]

其中[script]可以是脚本ID或文件路径。

将CLI作为Node.JS API使用

CLI可以被导入并在您的Node.JS应用程序中作为API使用。

关于混合文件和--vars

files 和 --vars 都是可变长度的命令行参数。也就是说，它们会消耗后面所有的输入项，直到遇到新的选项为止。因此在混合使用时顺序很重要。最佳做法是先列出文件，然后再使用 --vars 选项。

genaiscript run <script> [files...] --vars key1=value1 key2=value2

• 解析歧义

主题