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.
Install Node.JS (node) with a package manager.
Check your installation
You should see something similar or higher than the following versions:
Visual Studio Code Extension
The Visual Studio Code Marketplace contains the latest stable release of the extension.
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.
Open your project folder in Visual Studio Code.
Click on the Extensions view
Search genaiscript and click Install.
If successful, you will see the icon in the Extensions view.
(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 forTerminal: 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.
Open the latest release on GitHub
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
Open your project in Visual Studio Code
Right click on the
.vsix
file and select Install Extension VSIX…
Command Line
The genaiscript command line tool lets you run your GenAIScript from any terminal.
npx
will automatically install and cache the CLI. You can also add it as a devDependency
to your project.
Next steps
Let’s configure the LLM connection information