Installation

GenAiScript is available as a command line or a Visual Studio Code Extension.

Node.JS

GenAiScript requires Node.JS to run. We recommend installing the LTS version using a node version manager.

1. Install Node.JS (node) with a package manager.

2. Check your installation

   node -v
   npx -v

   You should see something similar or higher than the following versions:

   v20.11.1
   10.5.0

Visual Studio Code Extension

The Visual Studio Code Marketplace contains the latest stable release of the extension.

1. Install Visual Studio Code.

   Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux.

2. Open your project folder in Visual Studio Code.

3. Click on the Extensions view

   

4. Search genaiscript and click Install.

   

5. If successful, you will see the icon in the Extensions view.

   

6. (Optional) Click on the ⚙️ gearwheel icon on the extension page and select Add to Workspace Recommendations.

To install a specific version of the extension, we recommend storing the genaiscript.vsix in your repository and using the manual installation steps.

Default Profile for Terminal

GenAIScript launches a node server in the default terminal. If the default terminal is not configured or does not support node.js, you may need to update it in your user/workspace settings.

• Open command palette Ctrl+Shift+P and search for Terminal: Select Default Profile.
• Select the terminal profile like Git Bash

Manual Installation (Advanced)

The latest development build of the extension is also available on through the GitHub releases. This allows access to bug fixes earlier than the marketplace release.

1. Open the latest release on GitHub

2. Download the genaiscript.vsix into your project root folder

   • …
   • Directory.genaiscript/ folder created by the extension to store supporting files

     • Directorycache/ various cache files

       • …
     • Directoryretrieval/ retrieval database caches

       • …
     • … supporting files
   • genaiscript.vsix

3. Open your project in Visual Studio Code

4. Right click on the .vsix file and select Install Extension VSIX…

Cursor Support

GenAIScript can be installed in Cursor using the manual installation steps

Command Line

The genaiscript command line tool lets you run your GenAIScript from any terminal.

npx genaiscript run my-script some/path/*.pdf

npx will automatically install and cache the CLI. You can also add it as a devDependency to your project.

npm install -D genaiscript

Note

While most examples in the documentation assume you are using the Visual Studio Code extension, the command line tool lets you use GenAiScript from any editor as well.

Note

Some optional packages used by the CLI do not support an installation behind an HTTP proxy, which is very common in an enterprise setting.

If your work environment requires going through a proxy, you should use npm install --omit=optional to have optional packages fail gracefully during the installation.

Note

If your work environment requires going through a proxy, you can set one of the following environment variables (HTTP_PROXY, HTTPS_PROXY, http_proxy or https_proxy) to have the CLI use a proxy, e.g. HTTP_PROXY=http://proxy.acme.com:3128.

Next steps

Let’s configure the LLM connection information