Overview

The GenAIScript CLI genaiscript runs GenAIScript scripts outside of Visual Studio.

npx --yes genaiscript ...

where --yes skips the confirmation prompt to install the package.

Installation

The CLI is a Node.JS package hosted on npm.

1. Install Node.JS LTS (Node.JS includes npm and npx).

2. Install locally as a devDependency in your project.

   npm

   npm install -D genaiscript

   yarn

   yarn add -D genaiscript

   or install it globally.

   npm install -g genaiscript

Tip

Check that your node version is at least 20._ and npm 10._ by running this command.

node -v
npm -v

v20.11.1
v10.5.0

No Installation (npx)

Make sure to install Node.JS as described in step 1 above.

Using npx, you can run the cli without any prior installation steps. npx will install the tool on demand. npx also takes care of tricky operating system issues where the tool is not found in the path.

npx genaiscript ...

Add --yes to skip the confirmation prompt, which is useful in a CI scenario.

npx --yes genaiscript ...

You can also lock this call to a particular version.

npx --yes genaiscript@^1.16.0 ...

Create a new script

Creates a new script file in the genaisrc folder.

npx genaiscript scripts create <name>

Compile scripts

Runs the TypeScript compiler to find errors in the scripts.

npx genaiscript scripts compile

Run a script

Runs a genai script on file and streams the LLM output to stdout.

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

where <script> is the id or file path of the tool to run, and [files...] is the name of the spec file to run it on.

Secrets

The CLI will load the secrets from the environment variables or a ./.env file. You can also specify a different .env file using the --env option.