interintel 1.0.22 → 2.0.0

package/README.md

@@ -1,38 +1,137 @@
-## INTERINTEL
+# Interintel
 
-The application `interintel` is a command line interface (CLI) application implemented in Node.js. It essentially is an interactive communication tool between the user and an AI model, only GPTs for now.
+A CLI for local AI-assisted development. Chat with AI models running on your machine to read, search, edit files, and run commands—without sending your code to the cloud.
 
-Here's a brief overview of the main functionalities, as contained in the index.js file:
+## Features
 
-- The application starts an interactive session with the user. It does this by invoking the readline module, which reads user inputs line by line from the terminal.
+- **Local-first**: Works with Ollama for fully local AI (no data leaves your machine)
+- **Multi-provider**: Supports Ollama, OpenAI, and Mistral
+- **AI-driven tools**: AI can read files, search code, edit files, and run commands
+- **Permission system**: You control what the AI can do
+- **Fuzzy search**: Natural language queries find `chatCompletion`, `chat_completion`, etc.
 
--- 'node index.js' will start the app
-  
-- The OpenAI's API is accessed using API keys, and the version of AI being used is specified via a config. 
+## Requirements
 
-### //writeFile
-- If a user types '//writefile', the application prompts the user to provide a name for the file and then a prompt for the AI. It then automatically generates some text (by communicating with OpenAI's GPT-3 model), writes this to a file and stores it in the application's directory. 
-  
-### //readRefs
-- If a user writes '//readRefs', the application reads the content of the specified files in the interintel.config.js (in the current implementation) and uses this as part of the conversation with the AI.
-- So as you work on your project and files change or you move to other parts of the code base you can adjust where interintel points and what is referenced by AI conversation.
+- Node.js >= 18.0.0
+- [Ollama](https://ollama.ai/) (for local AI) with a tool-capable model:
+  - `llama3.1:8b` (recommended)
+  - `qwen2.5:7b`
+  - `gpt-oss:20b`
 
-### everything else
-- For all user inputs outside of these special keywords, the chat conversation is simply updated with the user's message and a call is made to the OpenAI API to generate the AI's response. This is then displayed on the console. 
+## Installation
 
-The application relies heavily on async-await pattern for handling the asynchronicity associated with reading user inputs and waiting for responses from the OpenAI 'aiChatCompletion' function. 
+```bash
+npm install interintel
+```
 
-Keep in mind that this is a high level overview and each functionality has its own level of implementation detail.
+Or clone and run locally:
+```bash
+git clone https://github.com/modern-sapien/interintel.git
+cd interintel
+npm install
+node index.js
+```
 
-File Structure
+## Configuration
 
-project/
-├── functions/
-│   ├── chat-functions.js
-│   ├── file-functions.js
-│   ├── openai-functions.js
-│   ├── messageUtils.js
-│   ├── writeFileHandler.js
-│   └── readRefsHandler.js
-├── interintel.config.js
-└── index.js
+After install, edit `interintel.config.js` in your project root:
+
+```javascript
+export default {
+  // 'ollama' | 'openai' | 'mistral'
+  aiService: 'ollama',
+
+  // Model name
+  aiVersion: 'llama3.1:8b',
+
+  // API key (only for OpenAI/Mistral)
+  apiKey: process.env.OPENAI_API_KEY || '',
+
+  // System prompt - customize AI behavior
+  systemPrompt: 'You are a direct, focused coding assistant.',
+
+  // Files to load into context
+  filePaths: [],
+};
+```
+
+## Usage
+
+```bash
+interintel
+# or
+node index.js
+```
+
+Then chat naturally:
+```
+You: What files are in this project?
+You: Find where fetchUser is defined
+You: Update the version in package.json to 2.0.0
+You: Run npm test
+```
+
+## AI Tools
+
+The AI has access to these tools:
+
+| Tool | Description | Permission |
+|------|-------------|------------|
+| `read_file` | Read file contents | Allowed |
+| `list_directory` | List files/folders | Allowed |
+| `search_directory` | Search code with fuzzy matching | Allowed |
+| `edit_file` | Modify existing files | Requires permission |
+| `write_file` | Create new files | Requires permission |
+| `run_command` | Execute shell commands | Requires permission |
+
+## Permissions
+
+Write and execute operations require your approval:
+
+```
+AI wants to write: src/index.js
+[y]es (once) / [n]o / [a]lways (save) / [g]lobal (trust all writes):
+```
+
+- `y` - Allow once (session only)
+- `n` - Deny
+- `a` - Always allow this directory (saved)
+- `g` - Trust all write operations (saved)
+
+View permissions with `//permissions`. Settings saved in `.interintel/interintel.permissions.json`.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `//plan <task>` | Collaborative planning mode - discuss approach before executing |
+| `//permissions` | Show current permission settings |
+| `//readrefs` | Load reference files from config |
+| `//writefile` | AI-assisted file creation |
+| `exit` | Quit interintel |
+
+## File Structure
+
+```
+interintel/
+├── index.js                # Entry point
+├── setup.js                # Postinstall setup
+├── src/
+│   ├── cli.js              # Main CLI loop
+│   ├── providers.js        # AI service interface (Ollama/OpenAI/Mistral)
+│   ├── tools/
+│   │   ├── definitions.json
+│   │   ├── executors.js
+│   │   ├── index.js
+│   │   └── permissions.js
+│   └── utils/
+│       ├── chat.js         # Readline helpers
+│       ├── files.js        # File operations
+│       └── writeFileHandler.js
+└── templates/
+    └── config.js           # Config template
+```
+
+## License
+
+Apache-2.0

package/index.js

@@ -1,99 +1,6 @@
-import path from 'path';
-import readline from 'readline';
-import dotenv from 'dotenv';
-import colors from 'colors';
-const configPath = path.join(process.cwd(), 'interintel.config.js');
-
-import config from './interintel.config.js';
-import { readSpecificFiles } from './functions/file-functions.js';
-import { askQuestion } from './functions/chat-functions.js';
-import { handleWriteFile } from './functions/handleWriteFile.js';
-import { chatCompletion } from './serviceInterface.js';
-
-dotenv.config();
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
-
-async function main() {
-  let initialContent = await readSpecificFiles(configPath);
-  let messages = [{ role: 'system', content: initialContent }];
-
-  let currentState = null;
-  let promptFileName = '';
-
-  while (true) {
-    const userMessage = await askQuestion(rl, 'You: '.blue.bold);
-    let response = '';
-
-    // Exit condition
-    if (userMessage.toLowerCase() === 'exit') {
-      console.log('Exiting chat...'.bgRed);
-      rl.close();
-      break;
-    }
-
-    if (userMessage.toLowerCase().startsWith('//writefile') && currentState === null) {
-      let result = await handleWriteFile(config, messages, currentState, '');
-      ({ currentState, messages, promptFileName, response } = result); // Update messages array
-      console.log(response.yellow);
-    } else if (currentState === 'awaitingFileName') {
-      ({ currentState, messages, promptFileName, response } = await handleWriteFile(
-        config,
-        messages,
-        currentState,
-        userMessage,
-        promptFileName
-      ));
-      console.log(response.yellow);
-    } else if (currentState === 'awaitingAIprompt') {
-      ({ currentState, messages, promptFileName, response } = await handleWriteFile(
-        config,
-        messages,
-        currentState,
-        userMessage,
-        promptFileName
-      ));
-      console.log(response.yellow);
-    } else if (currentState === null && userMessage.toLowerCase() === '//readrefs') {
-      console.log('System message:'.bgYellow);
-      console.log('Processing //readRefs command...'.yellow);
-
-      let content = readSpecificFiles(configPath);
-      messages.push({
-        role: 'user',
-        content: `please just acknowledge you have read the name and the content of the files I have provided. once you have done this a single time you do not need to do it again. ${content}`,
-      });
-      const completion = await chatCompletion(config.aiService, messages, config.aiVersion);
-
-      let botMessage = '';
-
-      if (config.aiService === 'openai' || config.aiService === 'mistral') {
-        botMessage = completion.choices[0].message.content;
-      } else if (config.aiService === 'ollama') {
-        // Adjust this line based on how Ollama's response is structured
-        botMessage = completion;
-      }
-    } else {
-      // Regular message processing and interaction with GPT model
-      messages.push({ role: 'user', content: userMessage });
-
-      const completion = await chatCompletion(config.aiService, messages, config.aiVersion);
-
-      let botMessage;
-      if (config.aiService === 'openai' || config.aiService === 'mistral') {
-        botMessage = completion.choices[0].message.content;
-      } else if (config.aiService === 'ollama') {
-        // Adjust based on Ollama's response format
-        botMessage = completion; // Example - replace with actual response structure for Ollama
-      }
-
-      console.log(`${config.aiVersion}`.bgGreen, botMessage.green);
-      console.log('----------------'.bgGreen);
-    }
-  }
-}
-
-export { main };
+#!/usr/bin/env node
+/**
+ * Interintel - Local AI Development Assistant
+ * Entry point - delegates to src/cli.js
+ */
+import './src/cli.js';

package/package.json

@@ -1,35 +1,49 @@
 {
+  "name": "interintel",
+  "version": "2.0.0",
+  "description": "CLI for local AI-assisted development with OpenAI, Mistral, and Ollama. Chat with AI to read, search, edit files and run commands.",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "interintel": "index.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "setup.js",
+    "src/",
+    "templates/"
+  ],
   "dependencies": {
     "@mistralai/mistralai": "^0.0.8",
     "colors": "^1.4.0",
     "dotenv": "^16.3.1",
+    "node-fetch": "^3.3.2",
     "openai": "^4.24.0"
   },
-  "name": "interintel",
-  "description": "The application `Interintel` is a command line interface (CLI) application implemented in Node.js. It essentially is an interactive communication tool between the user and an AI model, only openai models for now.",
-  "version": "1.0.22",
-  "type": "module",
-  "main": "index.js",
-  "directories": {
-    "doc": "docs"
-  },
   "scripts": {
-    "postinstall": "echo 'Running postinstall script...' && node setup.js",
-    "test": ""
+    "postinstall": "node setup.js",
+    "start": "node index.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/modern-sapien/inter-intel.git"
   },
   "keywords": [
-    "testing",
-    "development",
     "ai",
-    "debugging",
-    "copilot"
+    "cli",
+    "local-ai",
+    "ollama",
+    "openai",
+    "mistral",
+    "development",
+    "copilot",
+    "assistant"
   ],
   "author": "Modern-Sapien",
-  "license": "SEE LICENSE IN README.md",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/modern-sapien/inter-intel/issues"
   },

package/setup.js

@@ -1,46 +1,34 @@
-const fs = require('fs');
-const path = require('path');
-const colors = require('colors')
+#!/usr/bin/env node
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import colors from 'colors';
 
-const configPath = path.join('../../interintel.config.js');
-const templatePath = path.join(__dirname, '/resources/interintel.config.template.js');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-const readMePath = path.join('../../interintel/interintelReadMe.md');
-const readMeTemplate = path.join(__dirname, '/README.md');
+// When installed via npm, process.cwd() is the user's project root
+// When running locally, it's the interintel directory
+const projectRoot = process.cwd();
 
-// Creating directory to hold onto assets
-try {
-    fs.mkdirSync('../../interintel')
-} catch (error) {
-    console.log('Error occurred during setup:', error)
-}
-
-// Cloning config outside of node_modules and where root typically is
-try {
-    if (!fs.existsSync(configPath)) {
-        console.log('Config file does not exist, creating...');
-        fs.copyFileSync(templatePath, configPath);
-        console.log('Interintel config created. Please update it with your settings.'.yellow);
+const configPath = path.join(projectRoot, 'interintel.config.js');
+const templatePath = path.join(__dirname, 'templates/config.js');
 
-    } else {
-        console.log('Interintel config file already exists.');
-    }
-} catch (error) {
-    console.error('Error occurred during setup:', error);
-}
+console.log('Interintel setup...'.cyan);
+console.log(`Project root: ${projectRoot}`.gray);
 
-// Cloning README outside of node_modules and where root typically is
+// Create config file in user's project root
 try {
-    if (!fs.existsSync(readMePath)) {
-        console.log('Readme file does not exist, creating...');
-        fs.copyFileSync(readMeTemplate, readMePath);
-        console.log('Interintel readme created. Please update it with your settings.'.yellow);
-
-    } else {
-        console.log('Interintel readme file already exists.');
-    }
+  if (!fs.existsSync(configPath)) {
+    console.log('Creating interintel.config.js...'.yellow);
+    fs.copyFileSync(templatePath, configPath);
+    console.log('Config created! Edit interintel.config.js to set your AI service and model.'.green);
+  } else {
+    console.log('interintel.config.js already exists.'.gray);
+  }
 } catch (error) {
-    console.error('Error occurred during setup:', error);
+  // Likely running in a context where we can't write (e.g., global install)
+  console.log('Note: Could not create config file. Create interintel.config.js manually.'.yellow);
 }
 
-console.log("Finished running setup.js script.");
+console.log('Setup complete. Run "interintel" or "node index.js" to start.'.green);