scai 0.1.51 → 0.1.52

package/README.md

@@ -52,6 +52,80 @@ scai runs entirely on your machine and doesn't require cloud APIs or API keys. T
    scai init
    ```
 
+## ✨ AI Code Review, Powered by Your Terminal
+
+No more struggling to write pull request descriptions by hand. `scai git review` automatically generates a rich summary of your changes, complete with context, suggestions, and rationale.
+
+> ⚠️ These features are in **beta** — feedback welcome!
+
+## 🙌 Feedback
+
+Questions, ideas, or bugs?  
+Ping [@ticcr](https://bsky.app/profile/ticcr.xyz) on Bluesky — I'd love to hear your thoughts!
+
+
+---
+
+### 🔑 Setting Up Authentication (Required)
+
+To interact with GitHub and create pull requests, `scai` needs a personal access token with **repo** permissions.
+
+1. **Create your GitHub Access Token**
+   Follow this link to generate a token: [https://github.com/settings/tokens?type=beta](https://github.com/settings/tokens?type=beta)
+
+   Make sure you enable at least:
+
+   * `repo` (Full control of private repositories)
+   * `workflow` (If you want PRs to trigger CI)
+
+2. **Set the token in scai:**
+
+   ```bash
+   scai auth set
+   ```
+
+   This stores your token locally in a secure config file. You can inspect the setup at any time:
+
+   ```bash
+   scai auth check
+   ```
+
+3. **Set the index dir:**
+
+   ```bash
+   scai set index-dir <repo path>
+   ```
+
+   This is the repo from which scai will look up pull requests that can be reviewed. 
+
+---
+
+### 🧠 How to Use `scai git review`
+
+```bash
+scai git review
+```
+
+This will show you pull requests assigned to you for review:
+
+* Understand the diffs using a local model
+* Generate a structured pull request:
+
+  * ✅ Title
+  * ✅ Summary of changes
+  * ✅ Explanation of why the changes matter
+  * ✅ Optional changelog bullets
+
+You’ll be shown a preview and asked to confirm before pushing or opening a PR.
+
+#### Flags
+
+You can override behavior like this:
+
+```bash
+scai git review -a
+```
+This will show you all pull requests that have not yet been reviewed. 
 
 ## ⚒️ Usage Overview
 
@@ -205,7 +279,7 @@ You won't gain much value from the index unless you scope it to one repository.
 
 ## 🔄 Breaking Change in v0.1.47
 
-> 🛠️ As of `v0.1.47`, the internal database schema has changed.
+> 🛠️ As of `v0.1.47`, the internal database schema has changed, and may well change in the future.
 
 🚨 **OBS**: The **Migrate** command is for **internal use only**. Do **not** run it unless explicitly instructed, as it may delete existing data or corrupt your local database.
 
@@ -258,6 +332,10 @@ You may **not**:
 * ❌ Resell as a product or service
 * ❌ Claim ownership of the tool
 
-See [LICENSE](./LICENSE) for full terms.
+### 📄 License
+
+Free for personal and internal company use only.
+Commercial use (resale, SaaS, inclusion in paid tools) is prohibited.
+Contact me for commercial licensing.
 
 ```

package/dist/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+//!/usr/bin/env node
 import { Command } from "commander";
 import path from "path";
 import { Config } from './config.js';
@@ -30,14 +30,6 @@ const cmd = new Command('scai')
     .version(version)
     .option('--model <model>', 'Set the model to use (e.g., codellama:34b)')
     .option('--lang <lang>', 'Set the target language (ts, java, rust)');
-function defineSuggCommand(cmd) {
-    cmd
-        .command('sugg')
-        .description('Suggest a commit message from staged changes')
-        .option('-c, --commit', 'Automatically commit with suggested message')
-        .option('-l, --changelog', 'Generate and optionally stage a changelog entry')
-        .action((options) => suggestCommitMessage(options));
-}
 // 🔧 Main command group
 cmd
     .command('init')
@@ -46,20 +38,22 @@ cmd
     await bootstrap();
     console.log('✅ Model initialization completed!');
 });
-// Register top-level `sugg` command
-defineSuggCommand(cmd);
 // 🔧 Group: Git-related commands
 const git = cmd.command('git').description('Git utilities');
 git
     .command('review')
     .description('Review an open pull request using AI')
-    .option('-a, --all', 'Show all PRs requiring a review (not just for the current user)', false) // New option for showing all PRs
+    .option('-a, --all', 'Show all PRs requiring a review (not just for the current user)', false)
     .action(async (cmd) => {
-    const showAll = cmd.all; // Access the flag passed via command line
-    await reviewPullRequestCmd('main', showAll); // Pass the flag to the review function
+    const showAll = cmd.all;
+    await reviewPullRequestCmd('main', showAll);
 });
-// Register `sugg` under `git` group
-defineSuggCommand(git);
+git
+    .command('sugg')
+    .description('Suggest a commit message from staged changes')
+    .option('-c, --commit', 'Automatically commit with suggested message')
+    .option('-l, --changelog', 'Generate and optionally stage a changelog entry')
+    .action((options) => suggestCommitMessage(options));
 // Add auth-related commands
 const auth = cmd.command('auth').description('GitHub authentication commands');
 auth
@@ -72,7 +66,6 @@ auth
             console.log('❌ GitHub authentication not found. Please set your token.');
             return;
         }
-        // Call the new check
         const result = await validateGitHubTokenAgainstRepo();
         console.log(result);
     }
@@ -84,16 +77,10 @@ auth
     .command('reset')
     .description('Reset GitHub authentication credentials')
     .action(() => {
-    Config.setGitHubToken(''); // Clears the GitHub token from the config
+    Config.setGitHubToken('');
     console.log('🔄 GitHub authentication has been reset.');
-    // Check if the token is successfully removed
     const token = Config.getGitHubToken();
-    if (!token) {
-        console.log('✅ Token successfully removed from configuration.');
-    }
-    else {
-        console.log('❌ Token still exists in the configuration.');
-    }
+    console.log(token ? '❌ Token still exists in the configuration.' : '✅ Token successfully removed.');
 });
 auth
     .command('set')
@@ -147,14 +134,12 @@ set
     Config.setIndexDir(path.resolve(dir));
     Config.show();
 });
-// 🧪 Diagnostics and info
 cmd
     .command('config')
     .description('Show the currently active model and language settings')
     .action(() => {
     Config.show();
 });
-// 🔍 Indexing
 cmd
     .command('index [targetDir]')
     .description('Index supported files in the given directory (or current folder if none)')
@@ -166,24 +151,22 @@ cmd
     .command('backup')
     .description('Backup the current .scai folder')
     .action(runBackupCommand);
-// 🧠 Query and assistant
 cmd
     .command('find <query>')
     .description('Search indexed files by keyword')
     .action(runFindCommand);
 cmd
-    .command('ask [question...]') // <- the ... makes it variadic
+    .command('ask [question...]')
     .description('Ask a question based on indexed files')
     .action((questionParts) => {
     const fullQuery = questionParts?.join(' ');
     runAskCommand(fullQuery);
 });
-// 🛠️ Background tasks and maintenance
 cmd
     .command('daemon')
     .description('Run background summarization of indexed files')
     .action(async () => {
-    await startDaemon(); // ignore the return value
+    await startDaemon();
 });
 cmd
     .command('stop-daemon')
@@ -204,9 +187,10 @@ cmd
     .command('reset-db')
     .description('Delete and reset the SQLite database')
     .action(() => resetDatabase());
-// 🧬 Fallback: Pipeline mode
 cmd
-    .arguments('<file>')
+    .command('pipe')
+    .description('Run a module pipeline on a given file')
+    .argument('<file>', 'Target file')
     .option('-m, --modules <modules>', 'Comma-separated list of modules to run (e.g., comments,cleanup,summary)')
     .action((file, options) => {
     if (!options.modules) {
@@ -215,7 +199,6 @@ cmd
     }
     runModulePipelineFromCLI(file, options);
 });
-// Add explanation about alpha features directly in the help menu
 cmd.addHelpText('after', `
 🚨 Alpha Features:
   - The "index", "daemon", "stop-daemon", "reset-db" commands are considered alpha features.
@@ -223,9 +206,7 @@ cmd.addHelpText('after', `
 
 💡 Use with caution and expect possible changes or instability.
 `);
-// ✅ Parse CLI args
 cmd.parse(process.argv);
-// 🔁 Apply global options post-parse
 const opts = cmd.opts();
 if (opts.model)
     Config.setModel(opts.model);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.51",
+  "version": "0.1.52",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"
@@ -16,9 +16,19 @@
     "ai",
     "refactor",
     "devtools",
+    "developer-tools",
     "local",
+    "offline",
     "typescript",
-    "llm"
+    "llm",
+    "code-review",
+    "commit-message",
+    "git",
+    "changelog",
+    "productivity",
+    "scai",
+    "review",
+    "commit"
   ],
   "scripts": {
     "build": "rm -rfd dist && tsc && git add .",
@@ -46,4 +56,4 @@
     "dist/",
     "README.md"
   ]
-}
+}