vibora 1.15.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -14,9 +14,28 @@ The Vibe Engineer's Cockpit. A terminal-first tool for orchestrating AI coding a
14
14
 
15
15
  ## Quick Start
16
16
 
17
- Requires [Node.js](https://nodejs.org/) and [Claude Code](https://claude.ai/code).
17
+ Requires [Bun](https://bun.sh/) and [Claude Code](https://claude.ai/code).
18
18
 
19
- ### Install via curl (recommended)
19
+ ### Desktop App (Recommended)
20
+
21
+ Download the latest release for your platform from [GitHub Releases](https://github.com/knowsuchagency/vibora/releases/latest):
22
+
23
+ - **macOS Apple Silicon**: `Vibora-X.X.X-macos-arm64.dmg`
24
+ - **macOS Intel**: `Vibora-X.X.X-macos-x64.dmg`
25
+ - **Linux**: `Vibora-X.X.X-linux-x64.AppImage`
26
+
27
+ The desktop app bundles everything—just install and run. It will:
28
+ - Start the Vibora server automatically
29
+ - Install the Claude Code plugin
30
+ - Check for updates on startup
31
+
32
+ > **macOS note**: On first launch, right-click the app and select "Open" to bypass Gatekeeper.
33
+
34
+ ### Web Application (Alternative)
35
+
36
+ Run Vibora as a web server if you prefer browser access or need remote server deployment.
37
+
38
+ #### Install via curl
20
39
 
21
40
  ```bash
22
41
  curl -fsSL https://raw.githubusercontent.com/knowsuchagency/vibora/main/install.sh | bash
@@ -24,7 +43,7 @@ curl -fsSL https://raw.githubusercontent.com/knowsuchagency/vibora/main/install.
24
43
 
25
44
  This installs vibora, the Claude Code plugin, and starts the server.
26
45
 
27
- ### Install via npm
46
+ #### Install via npm
28
47
 
29
48
  ```bash
30
49
  npx vibora@latest up
@@ -37,7 +56,33 @@ claude plugin marketplace add knowsuchagency/vibora
37
56
  claude plugin install vibora@vibora --scope user
38
57
  ```
39
58
 
40
- ### Server Commands
59
+ Open http://localhost:3333 in your browser.
60
+
61
+ ### Remote Server Setup
62
+
63
+ Run the backend on a remote server and connect from the desktop app or browser:
64
+
65
+ 1. **On the remote server:**
66
+ ```bash
67
+ # Install and start
68
+ npx vibora@latest up
69
+
70
+ # Configure for remote access
71
+ vibora config set remoteHost your-server.example.com
72
+ vibora config set basicAuthUsername admin
73
+ vibora config set basicAuthPassword your-secure-password
74
+ ```
75
+
76
+ 2. **Connect from desktop app:**
77
+ - Launch the app
78
+ - Click "Connect to Remote" (if local server not found)
79
+ - Enter the server URL: `your-server.example.com:3333`
80
+ - Enter credentials when prompted
81
+
82
+ 3. **Or access via browser:**
83
+ Open `http://your-server.example.com:3333`
84
+
85
+ ### Server Commands (Web Application)
41
86
 
42
87
  ```bash
43
88
  vibora up # Start server daemon
@@ -45,8 +90,6 @@ vibora down # Stop the server
45
90
  vibora status # Check if running
46
91
  ```
47
92
 
48
- Open http://localhost:3333 in your browser.
49
-
50
93
  ## Configuration
51
94
 
52
95
  Settings are stored in `.vibora/settings.json`. The vibora directory is resolved in this order:
@@ -59,7 +102,7 @@ Settings are stored in `.vibora/settings.json`. The vibora directory is resolved
59
102
  |---------|---------|---------|
60
103
  | port | `PORT` | 3333 |
61
104
  | defaultGitReposDir | `VIBORA_GIT_REPOS_DIR` | ~ |
62
- | hostname | `VIBORA_HOSTNAME` | (empty) |
105
+ | remoteHost | `VIBORA_REMOTE_HOST` | (empty) |
63
106
  | sshPort | `VIBORA_SSH_PORT` | 22 |
64
107
  | basicAuthUsername | `VIBORA_BASIC_AUTH_USERNAME` | null |
65
108
  | basicAuthPassword | `VIBORA_BASIC_AUTH_PASSWORD` | null |
@@ -189,3 +232,5 @@ See [DEVELOPMENT.md](DEVELOPMENT.md) for development setup, architecture, and co
189
232
  ## License
190
233
 
191
234
  [PolyForm Shield 1.0.0](LICENSE)
235
+
236
+ **In plain English:** You can use Vibora for any purpose—personal or commercial. KNOWSUCHAGENCY CORP has no claim over the software you build using Vibora. What's prohibited is reselling or redistributing Vibora itself for profit. The software is provided as-is with no warranty.