Overview
The GenAIScript CLI genaiscript runs GenAIScript scripts
outside of Visual Studio and in your automation.
npx --yes genaiscript ...where --yes skips the confirmation prompt to install the package.
Prerequisites
The CLI is a Node.JS package hosted on npm.
- Install Node.JS LTS (Node.JS includes npm and npx).
Installation
- Install locally as a
devDependencyin your project.
npm install -D genaiscriptyarn add -D genaiscript- Install it globally.
npm install -g genaiscript- Check that your node version is at least 20._ and npm 10._ by running this command.
node -vnpx -vv20.11.110.5.0No Installation (npx)
npxis installed with Node.JS.
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
--yesto skip the confirmation prompt, which is useful in a CI scenario.
npx --yes genaiscript ...- Specify the version range to avoid unexpected behavior with cached installations of the CLI using npx.
npx --yes genaiscript@^1.16.0 ...Configuration
The CLI will load the secrets from the environment variables or a ./.env file.
You can override the default .env file name by adding the --env myother.env file.
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 compileRun a script
Run a script on file and streams the LLM output to stdout. Run from the workspace root.
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.
Listing model configuration
Run the script model command to list the available scripts and their model configuration. This can be useful to diagnose configuration issues in CI/CD environments.
npx genaiscript scripts model [script]where [script] can be a script id or a file path.