feat: allow setting global gptscript variables

Author: thedadams

README.md

@@ -31,15 +31,24 @@ You will see "Hello, World!" in the output of the command.
 
 ## GPTScript
 
-The GPTScript instance allows the caller to run gptscript files, tools, and other operations (see below). There are
-currently no options for this class, so `new gptscript.GPTScript()` is all you need. Although, the intention is that a
-single instance is all you need for the life of your application, you should call `close()` on the instance when you
-are done.
+The GPTScript instance allows the caller to run gptscript files, tools, and other operations (see below). Note that the
+intention is that a single instance is all you need for the life of your application, you should call `close()` on the
+instance when you are done.
 
-## Options
+## Global Options
+
+When creating a `GTPScript` instance, you can pass the following global options. These options are also available as
+run `Options`. Anything specified as a run option will take precedence over the global option.
+
+- `APIKey`: Specify an OpenAI API key for authenticating requests
+- `BaseURL`: A base URL for an OpenAI compatible API (the default is `https://api.openai.com/v1`)
+- `DefaultModel`: The default model to use for OpenAI requests
+
+## Run Options
 
 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.
+As noted above, the Global Options are also available to specify here. These options would take precedence.
 
 - `cache`: Enable or disable caching. Default (true).
 - `cacheDir`: Specify the cache directory.

src/gptscript.ts

@@ -4,6 +4,31 @@ import child_process from "child_process"
 import {fileURLToPath} from "url"
 import net from "net"
 
+export interface GlobalOpts {
+	APIKey?: string
+	BaseURL?: string
+	DefaultModel?: string
+}
+
+function globalOptsToArgs(opts?: GlobalOpts): string[] {
+	const args: string[] = []
+	if (!opts) {
+		return args
+	}
+
+	if (opts.APIKey) {
+		args.push("--openai-api-key", opts.APIKey)
+	}
+	if (opts.BaseURL) {
+		args.push("--openai-base-url", opts.BaseURL)
+	}
+	if (opts.DefaultModel) {
+		args.push("--default-model", opts.DefaultModel)
+	}
+
+	return args
+}
+
 export interface RunOpts {
 	input?: string
 	disableCache?: boolean
@@ -15,6 +40,10 @@ export interface RunOpts {
 	confirm?: boolean
 	prompt?: boolean
 	env?: string[]
+
+	APIKey?: string
+	BaseURL?: string
+	DefaultModel?: string
 }
 
 export enum RunEventType {
@@ -40,7 +69,7 @@ export class GPTScript {
 
 	private ready: boolean
 
-	constructor() {
+	constructor(opts?: GlobalOpts) {
 		this.ready = false
 		GPTScript.instanceCount++
 		if (!GPTScript.serverURL) {
@@ -54,7 +83,9 @@ export class GPTScript {
 					GPTScript.serverURL = "http://" + u.hostname + ":" + String((s.address() as net.AddressInfo).port)
 					srv.close()
 
-					GPTScript.serverProcess = child_process.spawn(getCmdPath(), ["--listen-address", GPTScript.serverURL.replace("http://", ""), "sdkserver"], {
+					const args = globalOptsToArgs(opts)
+					args.push("--listen-address", GPTScript.serverURL.replace("http://", ""), "sdkserver")
+					GPTScript.serverProcess = child_process.spawn(getCmdPath(), args, {
 						env: process.env,
 						stdio: ["pipe"]
 					})

tests/gptscript.test.ts

@@ -12,7 +12,7 @@ describe("gptscript module", () => {
 			throw new Error("neither OPENAI_API_KEY nor GPTSCRIPT_URL is set")
 		}
 
-		g = new gptscript.GPTScript()
+		g = new gptscript.GPTScript({APIKey: process.env.GPTSCRIPT_API_KEY!})
 	})
 	afterAll(() => {
 		g.close()