Merge pull request #16 from thedadams/add-chdir

feat: add chdir option

Author: thedadams

Makefile

@@ -16,6 +16,8 @@ release:
 	git tag -a "$(VERSION)" -m "Release $(VERSION)"
 	# Push the tag to remote repository
 	git push origin "$(VERSION)"
+	# Install
+	npm install
 	# Publish to npm
 	npm run build && npm publish --access public
 

README.md

@@ -26,6 +26,16 @@ npm exec -c "gptscript https://get.gptscript.ai/echo.gpt --input 'Hello, World!'
 
 you will see "Hello, World!" in the output of the command.
 
+## 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
@@ -66,16 +76,6 @@ async function listModels() {
 
 Executes a prompt with optional arguments.
 
-**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. Default (true).
-- `cacheDir`: Specify the cache directory.
-
-**Usage:**
-
 ```javascript
 const gptscript = require('@gptscript-ai/gptscript');
 
@@ -93,19 +93,7 @@ try {
 
 ### execFile
 
-Executes a GPT script file with optional input and arguments.
-
-**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.
+Executes a GPT script file with optional input and arguments. The script is relative to the callers source directory.
 
 ```javascript
 const gptscript = require('@gptscript-ai/gptscript');
@@ -128,16 +116,6 @@ async function execFile() {
 
 Executes a gptscript with optional input and arguments, and returns the output streams.
 
-**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:**
-
 ```javascript
 const gptscript = require('@gptscript-ai/gptscript');
 
@@ -172,16 +150,6 @@ async function streamExec() {
 
 Executes a gptscript with optional input and arguments, and returns the output and event streams.
 
-**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:**
-
 ```javascript
 const gptscript = require('@gptscript-ai/gptscript');
 
@@ -218,16 +186,6 @@ async function streamExecWithEvents() {
 
 ### 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.
 
 ```javascript
@@ -258,16 +216,6 @@ async function streamExecFile() {
 
 ### 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.
 
 ```javascript

src/gptscript.js

@@ -12,6 +12,8 @@ function getCmdPath() {
 const optToArg = {
     cache: "--disable-cache=",
     cacheDir: "--cache-dir=",
+    quiet: "--quiet=",
+    chdir: "--chdir=",
 }
 
 function toArgs(opts) {

tests/gptscript.test.js

@@ -103,6 +103,20 @@ describe('gptscript module', () => {
                 fail('execFile threw an unexpected error.');
             }
         });
+
+        test('should execute test.gpt correctly when chdir is set', async () => {
+            const testGptPath = path.join(__dirname, 'fixtures');
+
+            try {
+                // By changing the directory here, we should be able to find the test.gpt file without prepending the path.
+                const result = await gptscript.execFile('test.gpt', null, {chdir: testGptPath});
+                expect(result).toBeDefined(); // Replace with more specific assertions based on your expectations
+                expect(result).toContain("Calvin Coolidge");
+            } catch (error) {
+                console.error(error);
+                fail('execFile threw an unexpected error.');
+            }
+        });
     });
 
     test('streamExecFile executes a prompt correctly', async () => {