This module provides a set of functions to interact with gptscripts. It allows for executing scripts, listing available tools and models, and more. The functions are designed to be used in a Node.js environment.

To use this module, you need to have Node.js installed on your system. Then, you can install the module via npm:

npm install @gptscript-ai/gptscript

This will install the gptscript binary in the node_modules/@gptscript-ai/gptscript/bin directory.

You can opt out of this behavior by setting the NODE_GPTSCRIPT_SKIP_INSTALL_BINARY=true environment variable before running npm install.

To use the module and run gptscripts, you need to first set the OPENAI_API_KEY environment variable to your OpenAI API key.

To ensure it is working properly, you can run the following command:

npm exec -c "gptscript https://get.gptscript.ai/echo.gpt --input 'Hello, World!'"

you will see "Hello, World!" in the output of the command.

These are optional options that can be passed to the various exec functions. None of the options is required, and the defaults will reduce the number of calls made to the Model API.

• disableCache: Enable or disable caching. Default (true).
• cacheDir: Specify the cache directory.
• quiet: No output logging
• chdir: Change current working directory
• subTool: Use tool of this name, not the first tool

Lists all the available built-in tools.

Usage:

const gptscript = require('@gptscript-ai/gptscript');

async function listTools() {
	const tools = await gptscript.listTools();
	console.log(tools);
}

Lists all the available models, returns a list.

Usage:

const gptscript = require('@gptscript-ai/gptscript');

async function listModels() {
	let models = [];
	try {
		models = await gptscript.listModels();
	} catch (error) {
		console.error(error);
	}
}

Get the first of the current gptscript binary being used for the calls.

Usage:

const gptscript = require('@gptscript-ai/gptscript');

async function version() {
	try {
		console.log(await gptscript.version());
	} catch (error) {
		console.error(error);
	}
}

Executes a prompt with optional arguments. The first argument can be a ToolDef, an array of ToolDefs, or a string representing the contents of a gptscript file.

const gptscript = require('@gptscript-ai/gptscript');

const t = {
	instructions: "Who was the president of the united states in 1928?"
};

try {
	const run = gptscript.evaluate(t);
	console.log(await run.text());
} catch (error) {
	console.error(error);
}

Executes a GPT script file with optional input and arguments. The script is relative to the callers source directory.

const gptscript = require('@gptscript-ai/gptscript');

const opts = {
	disableCache: true,
	input: "--input World"
};

async function execFile() {
	try {
		const run = gptscript.run('./hello.gpt', opts);
		console.log(await run.text());
	} catch (e) {
		console.error(e);
	}
}

The Run object exposes event handlers so callers can access the progress events as the script is running.

The Run object exposes these events with their corresponding event type:

Subscribing to RunEventType.Event gets you all events.

const gptscript = require('@gptscript-ai/gptscript');

const opts = {
	disableCache: true,
	input: "--testin how high is that there mouse?"
};

async function streamExecFileWithEvents() {
	try {
		const run = gptscript.run('./test.gpt', opts);

		run.on(gptscript.RunEventType.Event, data => {
			console.log(`event: ${data}`);
		});

		await run.text();
	} catch (e) {
		console.error(e);
	}
}

Copyright (c) 2024, Acorn Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http:https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.