openai-code-assistant 1.0.2 → 1.0.4

package/README.md

@@ -54,16 +54,20 @@ openai-code-assistant
 npx openai-code-assistant
 ```
 
+## Demo
+
+![Demo preview](./docs/assets/1.0.3.gif)
+
 ## Prerequisites
 
-- Node.js installed (recommended version 16 or later).
+- Node.js installed (recommended version 22 or later).
 - OpenAI API key set in your environment variables as `OPENAI_API_KEY`.
-- Optionally, specify the OpenAI model name using the environment variable `OPENAI_MODEL_NAME`. Defaults to `gpt-3.5-turbo` if not set.
+- Optionally, specify the OpenAI model name using the environment variable `OPENAI_MODEL_NAME`. Defaults to `gpt-4.1-mini` if not set.
 
 ## Privacy
 
-This project is private and intended for internal use.
+The source code of this project is private and not for public distribution. However, the use of openai-code-assistant in any projects, whether internal or external, is welcomed and encouraged.
 
 ## License
 
-Private use only. Not for public distribution.
+The source code is private and not licensed for public distribution or modification. Usage of the tool itself in projects is permitted as described in the Privacy section.

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAGvB,eAAO,MAAM,iBAAiB,QACoB,CAAC;AAEnD,eAAO,MAAM,cAAc,QAEV,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAGvB,eAAO,MAAM,iBAAiB,QACmB,CAAC;AAElD,eAAO,MAAM,cAAc,QAEV,CAAC"}

package/dist/config.js

@@ -1,6 +1,6 @@
 import "dotenv/config";
 import path from "node:path";
-export const OPENAI_MODEL_NAME = process.env.OPENAI_MODEL_NAME || "gpt-3.5-turbo";
+export const OPENAI_MODEL_NAME = process.env.OPENAI_MODEL_NAME || "gpt-4.1-mini";
 export const WORKSPACE_ROOT = process.env.AGENT_WORKSPACE_ROOT
     ? path.resolve(process.env.AGENT_WORKSPACE_ROOT)
     : process.cwd();

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,CAAC,MAAM,iBAAiB,GAC5B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,eAAe,CAAC;AAEnD,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB;IAC5D,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAChD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,CAAC,MAAM,iBAAiB,GAC5B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,cAAc,CAAC;AAElD,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB;IAC5D,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAChD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC"}

package/dist/utils/generate-documentation.js

@@ -1,6 +1,6 @@
 import OpenAI from "openai";
 import { readFileContent } from "./files.js";
-const MODEL = "gpt-3.5-turbo";
+import { OPENAI_MODEL_NAME } from "../config.js";
 const openai = new OpenAI();
 export async function generateDocumentation(filePath) {
     const fileContent = readFileContent(filePath);
@@ -8,7 +8,7 @@ export async function generateDocumentation(filePath) {
         return "Error: Unable to read file content.";
     }
     const response = await openai.completions.create({
-        model: MODEL,
+        model: OPENAI_MODEL_NAME,
         prompt: `Generate documentation for the following code:\n\n${fileContent}`,
         max_tokens: 300,
     });

package/dist/utils/generate-documentation.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../src/utils/generate-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,KAAK,GAAG,eAAe,CAAC;AAC9B,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAE9C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,qCAAqC,CAAC;IAC/C,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;QAC/C,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE,qDAAqD,WAAW,EAAE;QAC1E,UAAU,EAAE,GAAG;KAChB,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;AACnC,CAAC"}
+{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../src/utils/generate-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAE9C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,qCAAqC,CAAC;IAC/C,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;QAC/C,KAAK,EAAE,iBAAiB;QACxB,MAAM,EAAE,qDAAqD,WAAW,EAAE;QAC1E,UAAU,EAAE,GAAG;KAChB,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;AACnC,CAAC"}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "openai-code-assistant",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "start": "node dist/index.js",
     "dev": "tsx src/index.ts",
     "typecheck": "tsc --noEmit",
-    "build": "tsc"
+    "build": "tsc && npm run copy-docs",
+    "copy-docs": "node scripts/copy-docs.mjs"
   },
   "bin": {
     "openai-code-assistant": "dist/index.js"
@@ -14,6 +15,20 @@
   "author": "https://github.com/shamshodisaev",
   "license": "ISC",
   "description": "",
+  "keywords": [
+    "OpenAI",
+    "AI agents",
+    "CLI tool",
+    "code assistant",
+    "code review",
+    "documentation generator",
+    "refactoring",
+    "supervisor agent",
+    "AI task orchestration",
+    "chatbot",
+    "OpenAI CLI",
+    "interactive assistant"
+  ],
   "type": "module",
   "devDependencies": {
     "@types/node": "^25.3.3",

package/scripts/copy-docs.mjs

@@ -0,0 +1,49 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const rootDir = path.resolve(fileURLToPath(new URL("../", import.meta.url)));
+const docsDir = path.join(rootDir, "docs");
+const targetDir = path.join(rootDir, "dist", "docs");
+
+async function pathExists(dir) {
+  try {
+    await fs.access(dir);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function copyDirectory(src, dest) {
+  await fs.mkdir(dest, { recursive: true });
+  const entries = await fs.readdir(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      await copyDirectory(srcPath, destPath);
+    } else {
+      await fs.copyFile(srcPath, destPath);
+    }
+  }
+}
+
+async function main() {
+  const hasDocs = await pathExists(docsDir);
+  if (!hasDocs) {
+    console.log("No docs directory detected. Skipping docs copy.");
+    return;
+  }
+
+  await fs.rm(targetDir, { recursive: true, force: true });
+  await copyDirectory(docsDir, targetDir);
+  console.log(`Copied docs to ${path.relative(rootDir, targetDir)}`);
+}
+
+main().catch((error) => {
+  console.error("Failed to copy docs:", error);
+  process.exitCode = 1;
+});