Merge pull request #1 from thedadams/add-chdir

feat: add chdir option

Author: thedadams

README.md

@@ -16,6 +16,16 @@ To use the module, you need to first set the OPENAI_API_KEY environment variable
 
 Additionally, you need the `gptscript` binary. You can install it on your system using the [installation instructions](https://github.com/gptscript-ai/gptscript?tab=readme-ov-file#1-install-the-latest-release).
 
+## 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.
+
+- `cache`: Enable or disable caching. Default (true).
+- `cacheDir`: Specify the cache directory.
+- `quiet`: No output logging
+- `chdir`: Change current working directory
+
 ## Functions
 
 ### listTools
@@ -62,16 +72,6 @@ func listModels(ctx context.Context) ([]string, error) {
 
 Executes a prompt with optional arguments.
 
-**Options:**
-
-These are optional options that can be passed to the `ExecTool` functions.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching. Default (true).
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 ```go
 package main
 
@@ -92,19 +92,7 @@ func runTool(ctx context.Context) (string, error) {
 
 ### ExecFile
 
-Executes a GPT script file with optional input and arguments.
-
-**Options:**
-
-These are optional options that can be passed to the `ExecFile` function.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching.
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
-The script is relative to the callers source directory.
+Executes a GPT script file with optional input and arguments. The script is relative to the callers source directory.
 
 ```go
 package main
@@ -128,16 +116,6 @@ func execFile(ctx context.Context) (string, error) {
 
 Executes a gptscript with optional input and arguments, and returns the output streams.
 
-**Options:**
-
-These are optional options that can be passed to the `StreamExecTool` function.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching.
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 ```go
 package main
 
@@ -164,16 +142,6 @@ func streamExecTool(ctx context.Context) error {
 
 Executes a gptscript with optional input and arguments, and returns the stdout, stderr, and gptscript events streams.
 
-**Options:**
-
-These are optional options that can be passed to the `StreamExecTool` function.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching.
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 ```go
 package main
 
@@ -198,16 +166,6 @@ func streamExecTool(ctx context.Context) error {
 
 ### streamExecFile
 
-**Options:**
-
-These are optional options that can be passed to the `exec` function.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching.
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 The script is relative to the callers source directory.
 
 ```go
@@ -234,16 +192,6 @@ func streamExecTool(ctx context.Context) error {
 
 ### streamExecFileWithEvents
 
-**Options:**
-
-These are optional options that can be passed to the `exec` function.
-Neither option is required, and the defaults will reduce the number of calls made to the Model API.
-
-- `cache`: Enable or disable caching.
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 The script is relative to the callers source directory.
 
 ```go

exec.go

@@ -14,6 +14,21 @@ type Opts struct {
 	DisableCache bool
 	CacheDir     string
 	Quiet        bool
+	Chdir        string
+}
+
+func (o Opts) toArgs() []string {
+	var args []string
+	if o.DisableCache {
+		args = append(args, "--disable-cache")
+	}
+	if o.CacheDir != "" {
+		args = append(args, "--cache-dir="+o.CacheDir)
+	}
+	if o.Chdir != "" {
+		args = append(args, "--chdir="+o.Chdir)
+	}
+	return append(args, "--quiet="+fmt.Sprint(o.Quiet))
 }
 
 // ListTools will list all the available tools.
@@ -33,7 +48,7 @@ func ListModels(ctx context.Context) ([]string, error) {
 
 // ExecTool will execute a tool. The tool must be a fmt.Stringer, and the string should be a valid gptscript file.
 func ExecTool(ctx context.Context, opts Opts, tools ...fmt.Stringer) (string, error) {
-	c := exec.CommandContext(ctx, getCommand(), append(toArgs(opts), "-")...)
+	c := exec.CommandContext(ctx, getCommand(), append(opts.toArgs(), "-")...)
 	c.Stdin = strings.NewReader(concatTools(tools))
 	out, err := c.CombinedOutput()
 	return string(out), err
@@ -43,7 +58,7 @@ func ExecTool(ctx context.Context, opts Opts, tools ...fmt.Stringer) (string, er
 // This returns two io.ReadClosers, one for stdout and one for stderr, and a function to wait for the process to exit.
 // Reading from stdOut and stdErr should be completed before calling the wait function.
 func StreamExecTool(ctx context.Context, opts Opts, tools ...fmt.Stringer) (io.Reader, io.Reader, func() error) {
-	c, stdout, stderr, err := setupForkCommand(ctx, "", append(toArgs(opts), "-"))
+	c, stdout, stderr, err := setupForkCommand(ctx, "", append(opts.toArgs(), "-"))
 	if err != nil {
 		return stdout, stderr, func() error { return err }
 	}
@@ -68,7 +83,7 @@ func StreamExecToolWithEvents(ctx context.Context, opts Opts, tools ...fmt.Strin
 	// Close the parent pipe after starting the child process
 	defer eventsWrite.Close()
 
-	c, stdout, stderr, err := setupForkCommand(ctx, "", append(toArgs(opts), "-"))
+	c, stdout, stderr, err := setupForkCommand(ctx, "", append(opts.toArgs(), "-"))
 	if err != nil {
 		_ = eventsRead.Close()
 		return stdout, stderr, new(reader), func() error { return err }
@@ -95,7 +110,7 @@ func StreamExecToolWithEvents(ctx context.Context, opts Opts, tools ...fmt.Strin
 // The file at the path should be a valid gptscript file.
 // The input should be command line arguments in the form of a string (i.e. "--arg1 value1 --arg2 value2").
 func ExecFile(ctx context.Context, toolPath, input string, opts Opts) (string, error) {
-	args := append(toArgs(opts), toolPath)
+	args := append(opts.toArgs(), toolPath)
 	if input != "" {
 		args = append(args, input)
 	}
@@ -110,7 +125,7 @@ func ExecFile(ctx context.Context, toolPath, input string, opts Opts) (string, e
 // This returns two io.ReadClosers, one for stdout and one for stderr, and a function to wait for the process to exit.
 // Reading from stdOut and stdErr should be completed before calling the wait function.
 func StreamExecFile(ctx context.Context, toolPath, input string, opts Opts) (io.Reader, io.Reader, func() error) {
-	args := append(toArgs(opts), toolPath)
+	args := append(opts.toArgs(), toolPath)
 	c, stdout, stderr, err := setupForkCommand(ctx, input, args)
 	if err != nil {
 		return stdout, stderr, func() error { return err }
@@ -136,7 +151,7 @@ func StreamExecFileWithEvents(ctx context.Context, toolPath, input string, opts
 	// Close the parent pipe after starting the child process
 	defer eventsWrite.Close()
 
-	args := append(toArgs(opts), toolPath)
+	args := append(opts.toArgs(), toolPath)
 
 	c, stdout, stderr, err := setupForkCommand(ctx, input, args)
 	if err != nil {
@@ -160,18 +175,6 @@ func StreamExecFileWithEvents(ctx context.Context, toolPath, input string, opts
 	return stdout, stderr, eventsRead, wait
 }
 
-func toArgs(opts Opts) []string {
-	var args []string
-	if opts.DisableCache {
-		args = append(args, "--disable-cache")
-	}
-	if opts.CacheDir != "" {
-		args = append(args, "--cache-dir="+opts.CacheDir)
-	}
-	args = append(args, "--quiet="+fmt.Sprint(opts.Quiet))
-	return args
-}
-
 func concatTools(tools []fmt.Stringer) string {
 	var sb strings.Builder
 	for i, tool := range tools {

exec_test.go

@@ -53,6 +53,18 @@ func TestSimpleExec(t *testing.T) {
 	}
 }
 
+func TestExecFileChdir(t *testing.T) {
+	// By changing the directory here, we should be able to find the test.gpt file without `./test` (see TestStreamExecFile)
+	out, err := ExecFile(context.Background(), "test.gpt", "", Opts{Chdir: "./test"})
+	if err != nil {
+		t.Errorf("Error executing tool: %v", err)
+	}
+
+	if out == "" {
+		t.Error("No output from tool")
+	}
+}
+
 func TestExecComplexTool(t *testing.T) {
 	tool := &Tool{
 		Tools:        []string{"sys.write"},