@vladimirven/openswe 1.0.0 → 1.0.1

package/README.md

@@ -4,163 +4,56 @@ openswe is an AI coding agent (opencode, claude code) orchestration tool. It con
 
 ## Requirements
 
-- Bun (runtime)
-- Zig (required to build OpenTUI native dependency)
-- tmux (session management)
-- Git
-- GitHub CLI (`gh`) with an authenticated account
-- macOS or Linux (TUI dependencies assume a POSIX environment)
+Before running openswe, ensure you have the following installed:
 
-## Install
+- **Git**: For version control operations.
+- **GitHub CLI (`gh`)**: Must be installed and authenticated (`gh auth login`).
+- **tmux**: Required for session management and isolation.
 
-```bash
-git clone <repo-url>
-cd openswe
-bun install
-```
-
-## Installation as Command
-
-To run `openswe` from anywhere in your terminal:
-
-### Option 1: Development Link (Recommended for contributors)
-
-This links the current project directory so changes are reflected immediately.
-
-```bash
-cd openswe
-chmod +x src/index.ts
-bun link
-```
-
-You can now run `openswe` from any directory.
-
-### Option 2: Standalone Binary (Compiled)
-
-To create a single executable file that can be moved anywhere (even to machines without Bun installed):
-
-```bash
-bun build ./src/index.ts --compile --outfile openswe
-mv openswe /usr/local/bin/
-```
-
-### Option 3: Manual Linking
-
-If you prefer to manually link the script:
-
-```bash
-chmod +x src/index.ts
-ln -s $(pwd)/src/index.ts /usr/local/bin/openswe
-```
-
-### Option 4: Bun Global Install
+## Installation
 
-You can install it globally from the local folder:
+### macOS & Linux (Homebrew)
 
 ```bash
-bun add -g .
+brew install vladimirven001/tap/openswe
 ```
 
-## Quick Start
+### NPM / Bun (Global)
 
-```bash
-bun run dev
-```
-
-If you want to run directly without the dev script:
+You can also install `openswe` globally using your preferred Node.js package manager:
 
 ```bash
-bun src/index.ts
-```
-
-## CLI Usage
-
-Run `openswe` with the following options:
+# npm
+npm install -g @vladimirven/openswe
 
-```bash
-bun src/index.ts [options]
+# bun
+bun add -g @vladimirven/openswe
 ```
 
-Options:
-
-- `--repo`, `-r`: GitHub repo in `owner/repo` format (used in setup wizard)
-- `--setup`: Force re-run the setup wizard
-- `--status`: Show project status without launching the TUI
-- `--backend`: AI backend (`opencode` or `claude`)
-- `--max-sessions`: Maximum concurrent sessions
-- `--debug`: Enable debug logging
+## Usage
 
-Examples:
+Start openswe in your project directory:
 
 ```bash
-bun src/index.ts --repo owner/repo
-bun src/index.ts --status
-bun src/index.ts --backend opencode --max-sessions 3
+openswe
 ```
 
-## Configuration
-
-OpenSWE supports configuration via CLI flags, environment variables, and a global config file. Precedence is:
-
-1. CLI flags (highest)
-2. Environment variables
-3. Global config file: `~/.config/openswe/config.toml`
-4. Built-in defaults (lowest)
-
-### Environment Variables
-
-- `OPENSWE_BACKEND`: `opencode` or `claude`
-- `OPENSWE_MAX_SESSIONS`: positive integer
-- `OPENSWE_LOG_LEVEL`: `debug`, `info`, `warn`, or `error`
-- `OPENSWE_PR_AUTO_CREATE`: `true` or `false`
-- `OPENSWE_PR_DRAFT`: `true` or `false`
-
-## Workspace Behavior
-
-OpenSWE detects the working directory and chooses a setup path:
-
-1. `.openswe/` exists: load existing project
-2. `.git/` exists: offer to adopt the repo
-3. `--repo` flag: clone into current directory
-4. Empty directory: run setup wizard
-
-Sessions run inside Git worktrees under `.worktrees/{issue-number}/` and project state lives in `.openswe/state.db`.
-
-## Scripts
+Or specify a repository directly:
 
 ```bash
-bun run dev          # Run the CLI in development mode
-bun run build        # Build to dist/
-bun test             # Run all tests
-bunx tsc --noEmit    # Type check (required after each iteration)
-```
-
-## Project Structure
-
-```text
-src/
-├── index.ts              # CLI entry point with yargs
-├── app.tsx               # Main Solid.js TUI application
-├── components/           # TUI components (SessionList, Preview, modals)
-├── core/                 # Session state machine, tmux manager, parser, queue
-├── workspace/            # Detect/init workspace, path utilities
-├── github/               # gh CLI wrapper, issues, PR creation
-├── git/                  # Clone, worktree operations
-├── store/                # SQLite db, sessions/tasks/project CRUD
-├── config/               # Types, global loader, defaults, env
-├── prompts/              # SWE system prompt template
-└── utils/                # Logger, ID generation, formatting
+openswe --repo owner/repo
 ```
 
-## Build Output
+### Common Options
 
-The build outputs a Bun-targeted bundle in `dist/`:
+- `--repo <owner/repo>`: Start on a specific GitHub repository.
+- `--backend <name>`: Choose AI backend (`opencode` or `claude`).
+- `--help`: Show all available options.
 
-```bash
-bun run build
-```
+## How It Works
 
-## Troubleshooting
+OpenSWE detects your current context to determine how to proceed:
 
-- If `@opentui/core` fails to install/build, verify Zig is installed and available in `PATH`.
-- If setup fails, confirm `gh auth status` shows an authenticated GitHub account.
+1.  **Existing Project**: If run in a folder with `.openswe/`, it loads the existing project state.
+2.  **Git Repo**: If run in a Git repository, it offers to adopt it.
+3.  **New Setup**: If run in an empty folder, it launches a setup wizard.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vladimirven/openswe",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "AI coding agent (opencode, claude code) orchestration tool for tackling github issues",
   "homepage": "https://github.com/vladimirven001/openswe#readme",
   "bugs": {