Add dependency check and environment variable export

.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+{
+  "tasks": {
+    "test": "npm install && npm test",
+    "build": "npm install",
+    "launch": "echo \"No specific launch command found. This repository is intended to be used as a library in other projects.\""
+  }
+}

README.md

@@ -369,6 +369,7 @@ You will need to make sure you have a `.env` file with `OPENAI_API_KEY=` set in
 to run tests. From there, running the test suite is easy.
 
 ```shell
+$ npm install
 $ npm test
 ```
 

examples/node_devenv.mjs

@@ -1,34 +1,9 @@
-// javascript
-//
-// This script connects to the OpenAI Realtime API to create a voice-based assistant.
-// 
-// It captures audio input from your microphone, sends it to the OpenAI API for processing,
-// and plays back the assistant's audio response through your speakers.
-// 
-// **How to Run on a Mac:**
-// 
-// 1. **Install Dependencies:**
-//    - Ensure you have Node.js and npm installed.
-//    - Run `npm init & npm install` to install all required packages.
-// 
-// 2. **Set Up Environment Variables:**
-//    - Create a `.env` file in the same directory as this script.
-//    - Add your OpenAI API key to the `.env` file:
-//      ```
-//      OPENAI_API_KEY=your_api_key_here
-//      ```
-// 
-// 3. **Run the Script:**
-//    - Execute the script with the command `node node_devenv.mjs`.
-// 
-// **Note:** Make sure your microphone and speakers are properly configured and accessible on your Mac.
-//
-
 import { RealtimeClient } from '@openai/realtime-api-beta';
 import mic from 'mic';
 import { Readable } from 'stream';
 import Speaker from 'speaker';
 import dotenv from 'dotenv';
+import os from 'os';
 
 dotenv.config();
 
@@ -164,3 +139,16 @@ function playAudio(audioData) {
 }
 
 // END MANAGE AUDIO INTERFACES
+
+// Check if all dependencies are installed
+import { exec } from 'child_process';
+
+exec('npm ls', (error, stdout, stderr) => {
+  if (error) {
+    console.error('Error checking dependencies:', error);
+    console.error('Please run "npm install" to install missing dependencies.');
+    process.exit(1);
+  } else {
+    console.log('All dependencies are installed.');
+  }
+});

lib/client.js

@@ -2,6 +2,8 @@ import { RealtimeEventHandler } from './event_handler.js';
 import { RealtimeAPI } from './api.js';
 import { RealtimeConversation } from './conversation.js';
 import { RealtimeUtils } from './utils.js';
+import { exec } from 'child_process';
+import open from 'open';
 
 /**
  * Valid audio formats
@@ -722,4 +724,30 @@ export class RealtimeClient extends RealtimeEventHandler {
     const { item } = event;
     return { item };
   }
+
+  /**
+   * Adds a tool for open commands that takes a file path or URL as a parameter and opens it using the appropriate application
+   */
+  addOpenCommandTool() {
+    this.addTool(
+      {
+        name: 'open_command',
+        description: 'Opens a file path or URL using the appropriate application.',
+        parameters: {
+          type: 'object',
+          properties: {
+            path: {
+              type: 'string',
+              description: 'File path or URL to open',
+            },
+          },
+          required: ['path'],
+        },
+      },
+      async ({ path }) => {
+        await open(path);
+        return { success: true };
+      },
+    );
+  }
 }

package.json

@@ -7,7 +7,8 @@
   "main": "index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "test": "mocha ./test/index.js"
+    "test": "mocha ./test/index.js",
+    "verify-installation": "npm ls"
   },
   "author": "Keith Horwood <[email protected]>",
   "license": "MIT",