scai 0.1.106 → 0.1.107

package/README.md

@@ -1,15 +1,33 @@
 # ⚙️ scai — Smart Commit AI ✨
 
-> AI-powered CLI tool for commit messages **and** pull request reviews — using local models.
+> AI-powered CLI tool for commit messages, pull request reviews, **and agent-driven workflows** — using local models.
 
 **scai** is your AI pair‑programmer in the terminal. Focus on coding while scai:
- 
-- 💬 **Suggests intelligent Git commit messages** based on your staged diff  
-- 🤖 **Reviews open pull requests** and provides AI‑driven feedback (BETA) 
-- 📝 **Generates comments for multiple files** while you keep coding
-- 📜 Auto‑updates your changelog  
-- 🔍 (ALPHA) Search & ask questions across your codebase  
-- 🔐 100% local — no API keys, no cloud, no telemetry  
+
+* 💬 **Suggests intelligent Git commit messages** based on your staged diff
+* 🤖 **Reviews open pull requests** and provides AI‑driven feedback (BETA)
+* 📝 **Generates comments for multiple files** while you keep coding
+* 🤖 **Runs agent workflows** to automate repetitive tasks like summarizing, commenting, or running tests — run agents on single files or entire folders with custom goals
+* 📜 Auto‑updates your changelog
+* 🔍 (ALPHA) Search & ask questions across your codebase
+* 🔐 100% local — no API keys, no cloud, no telemetry
+
+---
+
+### 🧩 Agent Mode Examples
+
+Run an agent workflow with goals:
+
+```bash
+# Run comments and tests on a single file
+$ scai agent run comments tests -f path/to/myfile
+
+# Run summary on all files in a folder
+$ scai agent run summary -f path/to/myfolder
+```
+
+The agent mode allows you to chain goals (`summary → comments → tests`) while processing files or directories automatically, keeping your workflow fast and focused.
+
 
 ---
 
@@ -52,6 +70,42 @@ scai runs entirely on your machine and doesn't require cloud APIs or API keys. T
    scai init
    ```
 
+---
+
+## 🤖 Agent Workflow Command
+
+The `agent` command allows you to run a sequence of AI-powered workflows (goals) on one or multiple files or even an entire folder. This is useful for tasks like generating comments, summaries, or tests, while letting the AI work in the background as you continue coding.
+
+### Usage
+
+```bash
+# Run agent with comments and tests on a single file
+scai agent run comments tests -f path/to/file.ts
+
+# Run agent on an entire folder
+scai agent run comments tests -f path/to/folder
+```
+
+You can provide multiple goals, which will be executed in the order specified. Currently supported example goals:
+
+* `summary` – Summarize a file
+* `comments` – Add inline comments to code
+* `tests` – Generate test stubs (ALPHA)
+
+#### Features
+
+* ✅ Works on single files or entire folders recursively
+* ✅ Processes multiple files in the background, so you can continue coding
+* ✅ Modular design allows you to chain goals (e.g., `comments → tests → summary`)
+
+#### Notes
+
+* Only `summary`, `comments`, and `tests` are currently fully supported. Other modules are experimental.
+* The agent resolves folders into all supported files (`.ts`, `.js`, etc.) automatically.
+* Background processing allows you to queue multiple files without waiting for each one to finish interactively.
+
+---
+
 ## ✨ 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.
@@ -95,6 +149,30 @@ To interact with GitHub and create pull requests, `scai` needs a personal access
 
 ---
 ## ⚒️ Usage Overview
+
+### 🔧  How to Use `scai git commit`
+
+Use AI to suggest a meaningful commit message based on your staged code:
+
+```bash
+git add .
+scai git commit
+```
+
+You can also include a changelog entry along with the commit:
+
+```bash
+scai git commit --changelog
+```
+
+This will:
+1. Suggest a commit message based on your `git diff --cached`
+2. Propose a changelog entry (if relevant)
+3. Allow you to approve, regenerate, or skip the changelog
+4. Automatically stage and commit the changes
+
+---
+
 ### 🧠 How to Use `scai git review`
 
 ```bash
@@ -182,31 +260,6 @@ You might consider renaming `sessionManager` to better reflect its dual role in
 5) 🚪 Cancel
 ```
 
-
-
-### 🔧  How to Use `scai git commit`
-
-Use AI to suggest a meaningful commit message based on your staged code:
-
-```bash
-git add .
-scai git commit
-```
-
-You can also include a changelog entry along with the commit:
-
-```bash
-scai git commit --changelog
-```
-
-This will:
-1. Suggest a commit message based on your `git diff --cached`
-2. Propose a changelog entry (if relevant)
-3. Allow you to approve, regenerate, or skip the changelog
-4. Automatically stage and commit the changes
-
----
-
 ### 📝 Generate a Standalone Changelog Entry
 
 If you want to generate a changelog entry without committing:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.106",
+  "version": "0.1.107",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"