@segosolutions/auto-task 1.3.0 → 1.5.0

package/README.md

@@ -34,11 +34,15 @@ This means less manual work for you and faster turnaround for your clients.
 
 ## Prerequisites
 
-> **Important:** You must have Claude Code CLI installed and authenticated before using this tool.
+> **Important:** The monitor uses the Claude Agent SDK by default. For legacy CLI mode, see the CLI Mode section below.
 
-### Claude Code CLI (Required)
+### Claude Agent SDK (Default)
 
-The monitor uses the Claude Code CLI to process tasks locally. Install and authenticate:
+The Agent SDK is included as a dependency and will be used automatically. No additional installation required.
+
+### Claude Code CLI (Legacy Mode)
+
+If you prefer to use the legacy CLI subprocess mode, install and authenticate:
 
 ```bash
 # Install globally
@@ -49,6 +53,9 @@ claude auth login
 
 # Verify it works
 claude --version
+
+# Run monitor in CLI mode
+sego-auto-task --use-cli-mode
 ```
 
 > **Note:** Claude Code requires an Anthropic account with API access.
@@ -70,12 +77,23 @@ npm install -g @segosolutions/auto-task
 # Step 2: Run the interactive setup wizard
 sego-auto-task init
 
-# Step 3: Start monitoring
+# Step 3: Start monitoring (that's it - smart defaults handle the rest!)
 sego-auto-task
 ```
 
 That's it! The monitor will now process eligible tasks automatically.
 
+### Smart Defaults
+
+When you run `sego-auto-task` with a configured `.env` file, intelligent defaults are applied:
+
+- **Agent SDK** is used by default (no `--use-agent-sdk` flag needed)
+- **Stream progress** is enabled by default (real-time updates in web UI)
+- **SSE/real-time mode** is enabled when `PROJECT_ID` is set
+- **Auto-commit/push** are disabled by default for safety
+
+The startup banner shows the source of each setting (`[cli]`, `[env]`, or `[default]`) so you always know where your configuration comes from.
+
 ### One-Liner (For the impatient)
 
 ```bash
@@ -161,7 +179,11 @@ Create a `.env` file in your project directory (or use `sego-auto-task init`):
 | `SEGO_API_URL` | No | `https://sego.pm` | API endpoint URL |
 | `SEGO_PROJECT_ID` | No | All projects | Filter to a specific project |
 | `SEGO_WORKING_DIR` | No | Current directory | Working directory for Claude |
+| `USE_CLI_MODE` | No | `false` | Use legacy CLI subprocess instead of Agent SDK |
+| `STREAM_PROGRESS` | No | `true` | Stream agent progress events to the web app |
 | `CONVERSATION_ONLY` | No | `false` | Only handle conversations, skip auto-tasks |
+| `AUTO_COMMIT` | No | `false` | Automatically commit changes after task completion |
+| `AUTO_PUSH` | No | `false` | Automatically push commits to remote (requires AUTO_COMMIT) |
 
 **Example `.env` file:**
 
@@ -173,7 +195,12 @@ SEGO_API_KEY=sk_live_your_key_here
 SEGO_API_URL=https://sego.pm
 SEGO_PROJECT_ID=proj_abc123
 SEGO_WORKING_DIR=/path/to/project
-CONVERSATION_ONLY=true  # Only process conversations, skip auto-tasks
+
+# Feature flags
+STREAM_PROGRESS=true     # Stream progress events to web app (default: true)
+CONVERSATION_ONLY=false  # Only process conversations, skip auto-tasks
+AUTO_COMMIT=false        # Automatically commit changes after task completion
+AUTO_PUSH=false          # Automatically push commits to remote
 ```
 
 ### CLI Options
@@ -190,7 +217,11 @@ All options can be passed via command line (overrides environment variables):
 | `--client-request-timeout <minutes>` | Client request analysis timeout | `2` |
 | `--no-sse` | Disable real-time SSE mode | SSE enabled |
 | `--dry-run` | Check for tasks without processing | `false` |
+| `--use-cli-mode` | Use legacy CLI subprocess instead of Agent SDK | `false` |
+| `--no-stream-progress` | Disable streaming progress events to the web app | Streaming enabled |
 | `--conversation-only` | Only handle conversational sessions, skip auto-task processing | `false` |
+| `--auto-commit` | Automatically commit changes after task completion | `false` |
+| `--auto-push` | Automatically push commits to remote (requires --auto-commit) | `false` |
 | `--working-dir <path>` | Working directory for Claude | Current directory |
 | `--no-update-check` | Skip update check on startup | Check enabled |
 | `-V, --version` | Show version number | |
@@ -286,7 +317,7 @@ New Request/Task Found
    Claim Task (mark IN_PROGRESS)
         |
         v
-   Run Claude with project context
+   Run Claude Agent SDK with project context
         |
         v
    Complete (move to IN_REVIEW)
@@ -295,6 +326,8 @@ New Request/Task Found
    Post results as task comment
 ```
 
+> **Note:** The monitor uses the Agent SDK by default for execution. Use `--use-cli-mode` to switch to the legacy CLI subprocess mode.
+
 ---
 
 ## Project Configuration (Sego PM)
@@ -435,9 +468,16 @@ docker run -d --name sego-monitor sego-auto-task
 
 ## Troubleshooting
 
-### "Claude CLI is not available"
+### "Claude Agent SDK is not available"
+
+The monitor uses the Agent SDK by default. This is bundled with the package, so this error is rare. If you encounter it:
+
+1. Reinstall the package: `npm install -g @segosolutions/auto-task`
+2. Or use legacy CLI mode: `sego-auto-task --use-cli-mode`
 
-The monitor requires the Claude Code CLI to be installed and authenticated.
+### "Claude CLI is not available" (Legacy Mode)
+
+If using `--use-cli-mode`, the Claude Code CLI must be installed and authenticated:
 
 ```bash
 # Install Claude CLI
@@ -639,6 +679,15 @@ node dist/index.cjs --help
 
 ## Changelog
 
+### v1.4.0
+
+- **Smart defaults**: Agent SDK and stream progress enabled by default
+- **Auto-commit/push**: Automatically commit and push changes after task completion
+- **Config source tracking**: Startup banner shows where each setting comes from (`[cli]`, `[env]`, `[default]`)
+- New CLI flags: `--auto-commit`, `--auto-push`, `--no-stream-progress`
+- New env vars: `AUTO_COMMIT`, `AUTO_PUSH`, `STREAM_PROGRESS`
+- Replaced `--use-agent-sdk` with `--use-cli-mode` (legacy mode)
+
 ### v1.0.1
 
 - Fixed repository URLs in package.json