Skip to content
GenAIScript
Blog

Running scripts

Visual Studio Code

In Visual Studio Code, the location where you start running a script determines the entries in the env.files variable.

Single file

  • Right click on a file in the Explorer and select Run GenAIScript….
  • Or right click in a file editor and select Run GenAIScript….

The env.files array will contain a single element with the selected file.

A file explorer window shows various files and folders. The file "Document.docx" is selected, and a context menu is open with the option "Run GenAiScript..." highlighted.

Folder

  • Right click on a folder in the Explorer and select **Run GenAIScript…**s.

The env.files array will contain all nested files under that folder.

The image shows a file explorer with a context menu. The "rag" folder is expanded, displaying files like "Document.docx." The context menu includes options like "New File," "Cut," "Copy," and "Run GenAiScript."

GitHub Copilot Chat

You can run scripts in the GitHub Copilot Chat through the @genaiscript participant.

A screenshot of the chat participant window.

Default files

You can specify default file or files to run the script on. When you run the script from the script file itself, or with the command line without file arguments, the default files will be used.

script({
    files: "path/to/files*.md",
})
...

Command Line

Use the run command to execute a script from the command line.

Terminal window
npx genaiscript run proofreader path/to/files*.md

Tasks

The GenAIScript extension exposes each script as a Task automatically.

The task launches the cli and runs the selected script and pass the path to the current opened editor.

  • Open the command palette Ctrl+Shift+P and search “Tasks: Run Task”
  • Select the genaiscript task provider
  • Select the script you want to run

Analyze results

By default, GenAIScript opens the output preview which shows a rendered view of the LLM output (assuming the LLM produces markdown).

The GenAIScript view provides an overview of the trace of the latest run.

You can also use the Trace to review the each transformation step of the script execution.

  • Click on the GenAIScript status bar icon and select Trace

A code editor displaying a JSON array with city data, including names, populations, and Wikipedia URLs. A toolbar at the top shows options like "Retry," "Output," and "Trace." The bottom right corner indicates "150 tokens."

Next steps

Debug your scripts using the Visual Studio Code Debugger!