cartographer-ai 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,76 @@
+# Cartographer CLI
+
+Cartographer CLI is a tool that detects changes in your source code and securely sends them to the Cartographer server, where AI automatically creates or updates the corresponding documentation. Designed to run in your CI/CD pipeline, it ensures your documentation stays accurate, up to date, and perfectly aligned with your evolving codebase, without retaining or using your code for any other purpose.
+
+## Features
+
+- **Automatic change detection**  
+  Detects which files have changed in your pull request, ensuring only modified code is processed.
+
+- **Server-driven documentation generation**  
+  The CLI itself does not generate documentation locally. Instead, it securely sends only the changed code to the Cartographer server, where AI generates or updates the relevant documentation. The code sent is **not stored**, **not retained**, and **never used to train any models**.
+
+- **Continuous updates**  
+  As your code evolves, Cartographer continuously produces new or updated documentation—no manual maintenance required.
+
+- **Language-agnostic**  
+  Works with any programming language and almost any codebase structure.
+
+- **Simple CI/CD integration**  
+  Easily integrates with GitHub Actions, GitLab CI, or any custom automation workflow.
+
+## CI/CD Integration Examples
+
+### GitHub Actions
+
+```sh
+name: Cartographer
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  cartographer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+
+      - name: Install Cartographer
+        run: npm i cartographer-ai
+
+      - name: Run Cartographer
+        run: |
+          npx cartographer apiKey=${{ secrets.API_KEY }}
+          npx cartographer spaceId=${{ secrets.SPACE_ID }}
+          npx cartographer dispatch
+```
+
+### GitLab CI/CD
+
+```sh
+stages:
+- cartographer
+
+cartographer:
+  stage: cartographer
+  image: node:24
+  only:
+    - main
+  before_script:
+    - npm i cartographer-ai
+  script:
+    - npx cartographer apiKey=${API_KEY}
+    - npx cartographer spaceId=${SPACE_ID}
+    - npx cartographer dispatch
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cartographer-ai",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "main": "src/commands.js",
   "type": "module",
   "bin": {
@@ -9,4 +9,4 @@
   "dependencies": {
     "axios": "^1.10.0"
   }
-}
+}

package/src/cartographer.js

@@ -73,7 +73,7 @@ export class Cartographer {
   }
 
   #getModifiedFiles() {
-    const command = "git diff --name-only && git diff --name-only --cached";
+    const command = "git diff --name-only HEAD~1 HEAD";
     const output = execSync(command, { encoding: "utf8" });
     return output.split("\n")?.reduce((arr, path) => {
       const formattedPath = path.trim();
@@ -90,8 +90,7 @@ export class Cartographer {
         },
       });
     } catch (error) {
-      console.error(
-        "Error:",
+      throw new Error(
         error?.response?.data?.error ?? "Unexpected error occured"
       );
     }
@@ -192,7 +191,7 @@ export class Cartographer {
 
         files[resolvedId].push(file);
       } catch (error) {
-        console.error(`Error reading file ${filePath}:`, error.message);
+        throw new Error(`Error reading file ${filePath}:`, error.message);
       }
     });
 

package/src/commands.js

@@ -33,8 +33,7 @@ export const saveConfig = (configPath, newConfig) => {
 
 const handleCartographerCommand = (arg) => {
   if (!arg) {
-    console.log("No command received");
-    return;
+    throw new Error("No command received");
   }
 
   const config = loadConfig(configPath);
@@ -47,7 +46,7 @@ const handleCartographerCommand = (arg) => {
     }, []);
 
     if (missingFields.length > 0) {
-      console.log(
+      throw new Error(
         `Error: Missing required fields: ${missingFields.join(", ")}`
       );
     } else {
@@ -60,6 +59,7 @@ const handleCartographerCommand = (arg) => {
       cartographer.dispatch();
       clearConfig(configPath);
     }
+
     return;
   }
 
@@ -70,9 +70,9 @@ const handleCartographerCommand = (arg) => {
   }
 
   const field = fields.find((field) => field === command);
+
   if (!field) {
-    console.log(`Unknown command: ${command}`);
-    return;
+    throw new Error(`Unknown command: ${command}`);
   }
 
   config[field] = value;