octoally 1.0.7

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.
Files changed (4) hide show
  1. package/LICENSE +223 -0
  2. package/README.md +281 -0
  3. package/cli.mjs +134 -0
  4. package/package.json +51 -0
package/LICENSE ADDED
@@ -0,0 +1,223 @@
1
+ Apache License 2.0 with Commons Clause
2
+
3
+ "Commons Clause" License Condition v1.0
4
+
5
+ The Software is provided to you by the Licensor under the Apache License,
6
+ Version 2.0 (the "License"), as defined below, subject to the following
7
+ condition.
8
+
9
+ Without limiting other conditions in the License, the grant of rights under
10
+ the License will not include, and the License does not grant to you, the
11
+ right to Sell the Software.
12
+
13
+ For purposes of the foregoing, "Sell" means providing to third parties, for a
14
+ fee or other consideration (including without limitation fees for hosting or
15
+ consulting/support services related to the Software), a product or service
16
+ whose value derives, entirely or substantially, from the functionality of the
17
+ Software. Any product or service that incorporates substantial portions of the
18
+ Software must be made available free of charge.
19
+
20
+ For clarity, the following uses are expressly permitted:
21
+ - Using the Software as a tool or workflow to develop other products or
22
+ services that you charge for, provided the Software itself is not included
23
+ in the distributed product.
24
+ - Modifying the Software for private, internal use without distributing it.
25
+ - Distributing modified or unmodified copies of the Software, provided such
26
+ distribution is free of charge.
27
+
28
+ Original Author: AI Genius Automations (https://aigeniusautomations.com)
29
+
30
+ ---
31
+
32
+ Apache License
33
+ Version 2.0, January 2004
34
+ http://www.apache.org/licenses/
35
+
36
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
37
+
38
+ 1. Definitions.
39
+
40
+ "License" shall mean the terms and conditions for use, reproduction,
41
+ and distribution as defined by Sections 1 through 9 of this document.
42
+
43
+ "Licensor" shall mean the copyright owner or entity authorized by
44
+ the copyright owner that is granting the License.
45
+
46
+ "Legal Entity" shall mean the union of the acting entity and all
47
+ other entities that control, are controlled by, or are under common
48
+ control with that entity. For the purposes of this definition,
49
+ "control" means (i) the power, direct or indirect, to cause the
50
+ direction or management of such entity, whether by contract or
51
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
52
+ outstanding shares, or (iii) beneficial ownership of such entity.
53
+
54
+ "You" (or "Your") shall mean an individual or Legal Entity
55
+ exercising permissions granted by this License.
56
+
57
+ "Source" form shall mean the preferred form for making modifications,
58
+ including but not limited to software source code, documentation
59
+ source, and configuration files.
60
+
61
+ "Object" form shall mean any form resulting from mechanical
62
+ transformation or translation of a Source form, including but
63
+ not limited to compiled object code, generated documentation,
64
+ and conversions to other media types.
65
+
66
+ "Work" shall mean the work of authorship, whether in Source or
67
+ Object form, made available under the License, as indicated by a
68
+ copyright notice that is included in or attached to the work
69
+ (an example is provided in the Appendix below).
70
+
71
+ "Derivative Works" shall mean any work, whether in Source or Object
72
+ form, that is based on (or derived from) the Work and for which the
73
+ editorial revisions, annotations, elaborations, or other modifications
74
+ represent, as a whole, an original work of authorship. For the purposes
75
+ of this License, Derivative Works shall not include works that remain
76
+ separable from, or merely link (or bind by name) to the interfaces of,
77
+ the Work and Derivative Works thereof.
78
+
79
+ "Contribution" shall mean any work of authorship, including
80
+ the original version of the Work and any modifications or additions
81
+ to that Work or Derivative Works thereof, that is intentionally
82
+ submitted to the Licensor for inclusion in the Work by the copyright owner
83
+ or by an individual or Legal Entity authorized to submit on behalf of
84
+ the copyright owner. For the purposes of this definition, "submitted"
85
+ means any form of electronic, verbal, or written communication sent
86
+ to the Licensor or its representatives, including but not limited to
87
+ communication on electronic mailing lists, source code control systems,
88
+ and issue tracking systems that are managed by, or on behalf of, the
89
+ Licensor for the purpose of discussing and improving the Work, but
90
+ excluding communication that is conspicuously marked or otherwise
91
+ designated in writing by the copyright owner as "Not a Contribution."
92
+
93
+ "Contributor" shall mean Licensor and any individual or Legal Entity
94
+ on behalf of whom a Contribution has been received by the Licensor and
95
+ subsequently incorporated within the Work.
96
+
97
+ 2. Grant of Copyright License. Subject to the terms and conditions of
98
+ this License, each Contributor hereby grants to You a perpetual,
99
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
100
+ copyright license to reproduce, prepare Derivative Works of,
101
+ publicly display, publicly perform, sublicense, and distribute the
102
+ Work and such Derivative Works in Source or Object form.
103
+
104
+ 3. Grant of Patent License. Subject to the terms and conditions of
105
+ this License, each Contributor hereby grants to You a perpetual,
106
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
107
+ (except as stated in this section) patent license to make, have made,
108
+ use, offer to sell, sell, import, and otherwise transfer the Work,
109
+ where such license applies only to those patent claims licensable
110
+ by such Contributor that are necessarily infringed by their
111
+ Contribution(s) alone or by combination of their Contribution(s)
112
+ with the Work to which such Contribution(s) was submitted. If You
113
+ institute patent litigation against any entity (including a
114
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
115
+ or a Contribution incorporated within the Work constitutes direct
116
+ or contributory patent infringement, then any patent licenses
117
+ granted to You under this License for that Work shall terminate
118
+ as of the date such litigation is filed.
119
+
120
+ 4. Redistribution. You may reproduce and distribute copies of the
121
+ Work or Derivative Works thereof in any medium, with or without
122
+ modifications, and in Source or Object form, provided that You
123
+ meet the following conditions:
124
+
125
+ (a) You must give any other recipients of the Work or
126
+ Derivative Works a copy of this License; and
127
+
128
+ (b) You must cause any modified files to carry prominent notices
129
+ stating that You changed the files; and
130
+
131
+ (c) You must retain, in the Source form of any Derivative Works
132
+ that You distribute, all copyright, patent, trademark, and
133
+ attribution notices from the Source form of the Work,
134
+ excluding those notices that do not pertain to any part of
135
+ the Derivative Works; and
136
+
137
+ (d) If the Work includes a "NOTICE" text file as part of its
138
+ distribution, then any Derivative Works that You distribute must
139
+ include a readable copy of the attribution notices contained
140
+ within such NOTICE file, excluding any notices that do not
141
+ pertain to any part of the Derivative Works, in at least one
142
+ of the following places: within a NOTICE text file distributed
143
+ as part of the Derivative Works; within the Source form or
144
+ documentation, if provided along with the Derivative Works; or,
145
+ within a display generated by the Derivative Works, if and
146
+ wherever such third-party notices normally appear. The contents
147
+ of the NOTICE file are for informational purposes only and
148
+ do not modify the License. You may add Your own attribution
149
+ notices within Derivative Works that You distribute, alongside
150
+ or as an addendum to the NOTICE text from the Work, provided
151
+ that such additional attribution notices cannot be construed
152
+ as modifying the License.
153
+
154
+ You may add Your own copyright statement to Your modifications and
155
+ may provide additional or different license terms and conditions
156
+ for use, reproduction, or distribution of Your modifications, or
157
+ for any such Derivative Works as a whole, provided Your use,
158
+ reproduction, and distribution of the Work otherwise complies with
159
+ the conditions stated in this License.
160
+
161
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
162
+ any Contribution intentionally submitted for inclusion in the Work
163
+ by You to the Licensor shall be under the terms and conditions of
164
+ this License, without any additional terms or conditions.
165
+ Notwithstanding the above, nothing herein shall supersede or modify
166
+ the terms of any separate license agreement you may have executed
167
+ with Licensor regarding such Contributions.
168
+
169
+ 6. Trademarks. This License does not grant permission to use the trade
170
+ names, trademarks, service marks, or product names of the Licensor,
171
+ except as required for reasonable and customary use in describing the
172
+ origin of the Work and reproducing the content of the NOTICE file.
173
+
174
+ 7. Disclaimer of Warranty. Unless required by applicable law or
175
+ agreed to in writing, Licensor provides the Work (and each
176
+ Contributor provides its Contributions) on an "AS IS" BASIS,
177
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
178
+ implied, including, without limitation, any warranties or conditions
179
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
180
+ PARTICULAR PURPOSE. You are solely responsible for determining the
181
+ appropriateness of using or redistributing the Work and assume any
182
+ risks associated with Your exercise of permissions under this License.
183
+
184
+ 8. Limitation of Liability. In no event and under no legal theory,
185
+ whether in tort (including negligence), contract, or otherwise,
186
+ unless required by applicable law (such as deliberate and grossly
187
+ negligent acts) or agreed to in writing, shall any Contributor be
188
+ liable to You for damages, including any direct, indirect, special,
189
+ incidental, or consequential damages of any character arising as a
190
+ result of this License or out of the use or inability to use the
191
+ Work (including but not limited to damages for loss of goodwill,
192
+ work stoppage, computer failure or malfunction, or any and all
193
+ other commercial damages or losses), even if such Contributor
194
+ has been advised of the possibility of such damages.
195
+
196
+ 9. Accepting Warranty or Additional Liability. While redistributing
197
+ the Work or Derivative Works thereof, You may choose to offer,
198
+ and charge a fee for, acceptance of support, warranty, indemnity,
199
+ or other liability obligations and/or rights consistent with this
200
+ License. However, in accepting such obligations, You may act only
201
+ on Your own behalf and on Your sole responsibility, not on behalf
202
+ of any other Contributor, and only if You agree to indemnify,
203
+ defend, and hold each Contributor harmless for any liability
204
+ incurred by, or claims asserted against, such Contributor by reason
205
+ of your accepting any such warranty or additional liability.
206
+
207
+ END OF TERMS AND CONDITIONS
208
+
209
+ Copyright 2025 AI Genius Automations (https://aigeniusautomations.com)
210
+
211
+ Licensed under the Apache License, Version 2.0 (the "License");
212
+ you may not use this file except in compliance with the License.
213
+ You may obtain a copy of the License at
214
+
215
+ http://www.apache.org/licenses/LICENSE-2.0
216
+
217
+ Unless required by applicable law or agreed to in writing, software
218
+ distributed under the License is distributed on an "AS IS" BASIS,
219
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
220
+ See the License for the specific language governing permissions and
221
+ limitations under the License.
222
+
223
+ Subject to the "Commons Clause" License Condition v1.0 above.
package/README.md ADDED
@@ -0,0 +1,281 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/ai-genius-automations/octoally/59dc5a2/dashboard/public/octoally-logo-lg.png" alt="OctoAlly" width="500">
3
+ <p align="center">
4
+ <strong>AI Coding Session Orchestration Dashboard</strong>
5
+ </p>
6
+ <p align="center">
7
+ The dashboard for Claude Code &amp; OpenAI Codex. Launch, monitor, and manage AI coding sessions<br>
8
+ with <a href="https://github.com/ruvnet/ruflo">RuFlo</a> multi-agent orchestration — all from one place.
9
+ </p>
10
+ </p>
11
+
12
+ <p align="center">
13
+ <a href="https://github.com/ai-genius-automations/octoally/stargazers"><img src="https://img.shields.io/github/stars/ai-genius-automations/octoally?style=flat&color=gold" alt="GitHub Stars"></a>
14
+ <a href="https://github.com/ai-genius-automations/octoally/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0%20+%20Commons%20Clause-blue" alt="License"></a>
15
+ <a href="https://github.com/ai-genius-automations/octoally/releases"><img src="https://img.shields.io/github/v/release/ai-genius-automations/octoally?color=green" alt="Release"></a>
16
+ <a href="https://octoally.com"><img src="https://img.shields.io/badge/website-octoally.com-blue" alt="Website"></a>
17
+ <a href="https://aigeniusautomations.com"><img src="https://img.shields.io/badge/by-AI%20Genius%20Automations-purple" alt="AI Genius Automations"></a>
18
+ </p>
19
+
20
+ ---
21
+
22
+ > **OctoAlly** is a local-first orchestration dashboard for [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [OpenAI Codex](https://github.com/openai/codex), and [RuFlo](https://github.com/ruvnet/ruflo). Run multi-agent hive-mind sessions, single-agent workflows, and interactive terminals — with both Claude and Codex CLIs — all from a beautiful web UI with real-time streaming.
23
+
24
+ ---
25
+
26
+ ## Screenshots
27
+
28
+ <p align="center">
29
+ <img src="docs/screenshots/active-sessions.png" alt="Active Sessions Grid" width="100%">
30
+ </p>
31
+
32
+ **Active Sessions Grid** — Monitor all your AI coding sessions at a glance. The grid view shows every running session across all projects — hive-mind agents, solo Claude Code sessions, and terminals — each with live-streaming output. Click any cell to expand, or use the column controls to fit your screen.
33
+
34
+ <table>
35
+ <tr>
36
+ <td width="50%">
37
+ <img src="docs/screenshots/projects.png" alt="Project Management">
38
+ <p><b>Project Management</b> — Organize all your projects in one place. Add project folders, track RuFlo status, manage git repos and branches, and launch sessions directly from the project card. Each project gets its own configuration and session history.</p>
39
+ </td>
40
+ <td width="50%">
41
+ <img src="docs/screenshots/hivemind.png" alt="Hive-Mind Session">
42
+ <p><b>Hive-Mind Session</b> — Multi-agent orchestration powered by RuFlo. A coordinator agent breaks your objective into subtasks, delegates to specialized workers, and uses Byzantine consensus to merge results. Shared memory and HNSW vector search let agents build on each other's work.</p>
43
+ </td>
44
+ </tr>
45
+ <tr>
46
+ <td width="50%">
47
+ <img src="docs/screenshots/terminal.png" alt="Terminal Session">
48
+ <p><b>Interactive Terminals</b> — Full terminal sessions managed through tmux. Pop out to a system terminal anytime, do your work, then adopt the session back into OctoAlly — it picks up right where you left off. Sessions persist across server restarts.</p>
49
+ </td>
50
+ <td width="50%">
51
+ <img src="docs/screenshots/source.png" alt="Git Source Control">
52
+ <p><b>Git Source Control</b> — Built-in git integration with side-by-side diffs, staged/unstaged changes, commit history, and a file explorer. Review what your AI agents changed, stage files, and commit — all without leaving the dashboard.</p>
53
+ </td>
54
+ </tr>
55
+ </table>
56
+
57
+ **More highlights:**
58
+
59
+ - **Reconnect anytime** — Close a tab, restart the server, even reboot — every session is backed by tmux and persists. Reconnect and pick up exactly where you left off with full scrollback.
60
+ - **Pop out & adopt back** — Open any session in your system terminal (`tmux attach`), work with your favorite tools, then bring it back into the dashboard. No lock-in.
61
+ - **Voice dictation** — Speak your instructions using local Whisper STT (no cloud, no data leaves your machine) or cloud APIs like OpenAI/Groq. API keys are encrypted at rest with AES-256-GCM.
62
+ - **Per-project agents** — Define custom agent personas in `.claude/agents/*.md` and launch them from the dashboard. Each project gets its own RuFlo config and agent definitions.
63
+ - **Dual CLI support** — Launch sessions with either Claude Code or OpenAI Codex. Each session tracks which CLI it uses, with branded icons and separate configuration.
64
+
65
+ ---
66
+
67
+ ## Features
68
+
69
+ - **Active Sessions Grid** — See every running session across all projects in a live-updating grid with real-time streaming output
70
+ - **Hive-Mind Sessions** — Launch multi-agent orchestration via [RuFlo](https://github.com/ruvnet/ruflo) with shared memory and consensus — supports both Claude Code and Codex
71
+ - **Agent Sessions** — Run single-agent sessions with Claude Code (`.claude/agents/*.md`) or Codex
72
+ - **Dual CLI Support** — Switch between Claude Code and OpenAI Codex per-session with branded icons, separate commands, and per-CLI settings
73
+ - **Interactive Terminals** — Full terminal sessions with tmux persistence — pop out to system terminal and adopt back anytime
74
+ - **Built-in Web Browser** — Browse and test web apps alongside your coding sessions with full OAuth support
75
+ - **Git Source Control** — Side-by-side diffs, staged changes, commit history, and file explorer — review and commit AI-generated changes in-app
76
+ - **File Explorer** — Browse your project files, open and edit them, all from the sidebar
77
+ - **Session Persistence** — Every session survives server restarts, tab closes, and reboots — reconnect with full scrollback
78
+ - **Real-Time Streaming** — WebSocket-powered live output, tool calls, and progress tracking
79
+ - **Multi-Project Support** — Per-project RuFlo initialization, agent configurations, and task queues
80
+ - **Voice Dictation** — Speak your instructions via local Whisper or cloud APIs (OpenAI, Groq) — keys encrypted at rest
81
+ - **Desktop App** — Electron system tray app with auto-launch, server management, and native STT
82
+
83
+ ---
84
+
85
+ ## Quick Install
86
+
87
+ ### Supported Platforms
88
+
89
+ | Platform | Status |
90
+ |----------|--------|
91
+ | **Linux** (Ubuntu/Debian) | Fully supported |
92
+ | **macOS** (Intel & Apple Silicon) | Fully supported |
93
+
94
+ ### Prerequisites
95
+
96
+ | Requirement | Why | Install |
97
+ |-------------|-----|---------|
98
+ | **Node.js 20+** | Runtime for the server | [nodejs.org](https://nodejs.org) |
99
+ | **Claude Code** | Anthropic's AI coding agent | `npm install -g @anthropic-ai/claude-code` |
100
+ | **Codex CLI** *(optional)* | OpenAI's AI coding agent | `npm install -g @openai/codex` |
101
+
102
+ > **Important:** Before installing OctoAlly, you must run Claude Code at least once to accept terms and enable non-interactive mode:
103
+ > ```bash
104
+ > claude # Accept terms & sign in
105
+ > claude --dangerously-skip-permissions # Enable non-interactive agent sessions
106
+ > ```
107
+ >
108
+ > For Codex support, also run:
109
+ > ```bash
110
+ > codex # Accept terms & sign in
111
+ > ```
112
+
113
+ ### One-Line Install
114
+
115
+ ```bash
116
+ curl -fsSL https://raw.githubusercontent.com/ai-genius-automations/octoally/main/scripts/install.sh | bash
117
+ ```
118
+
119
+ The installer will:
120
+ 1. Check for Node.js and Claude Code (offer to install if missing)
121
+ 2. Verify Claude Code has been initialized
122
+ 3. Download and extract the pre-built release
123
+ 4. Install the `octoally` CLI
124
+ 5. Start the server
125
+ 6. Optionally install the desktop app
126
+
127
+ > **Custom install location:** `OCTOALLY_INSTALL_DIR=/opt/octoally bash install.sh`
128
+
129
+ ### What you get
130
+
131
+ - **Web Dashboard:** http://localhost:42010
132
+ - **CLI:** `octoally start | stop | restart | status | update | logs`
133
+ - **Desktop App:** Optional Electron app with system tray and speech-to-text
134
+
135
+ ### Manual Install (Development)
136
+
137
+ ```bash
138
+ git clone https://github.com/ai-genius-automations/octoally.git
139
+ cd octoally
140
+
141
+ # Server
142
+ cd server && npm install && npm run build && cd ..
143
+
144
+ # Dashboard
145
+ cd dashboard && npm install && npm run build && cd ..
146
+
147
+ # Start
148
+ cd server && npm start
149
+ ```
150
+
151
+ - **Dashboard:** http://localhost:42010
152
+ - **Dev mode (with hot reload):** `cd server && npm run dev` + `cd dashboard && npm run dev`
153
+
154
+ ---
155
+
156
+ ## How It Works
157
+
158
+ OctoAlly is a dashboard that sits on top of **Claude Code**, **OpenAI Codex**, and **RuFlo**:
159
+
160
+ - **[Claude Code](https://docs.anthropic.com/en/docs/claude-code)** is Anthropic's CLI agent for coding tasks (uses `CLAUDE.md` for project instructions)
161
+ - **[OpenAI Codex](https://github.com/openai/codex)** is OpenAI's CLI agent for coding tasks (uses `AGENTS.md` for project instructions)
162
+ - **[RuFlo](https://github.com/ruvnet/ruflo)** adds multi-agent orchestration, hive-mind coordination, and memory to both CLIs
163
+ - **OctoAlly** provides the UI to manage projects, launch sessions, and monitor everything in real-time
164
+
165
+ When you add a project and enable RuFlo, OctoAlly automatically initializes the project with agent definitions, hive-mind support, and the configuration files both CLIs need (`CLAUDE.md` + `AGENTS.md`). You can then launch sessions with either Claude or Codex directly from the dashboard — each session tracks which CLI is running, with branded icons and per-CLI settings.
166
+
167
+ ---
168
+
169
+ ## CLI Commands
170
+
171
+ ```bash
172
+ octoally start # Start the server (background)
173
+ octoally stop # Stop the server
174
+ octoally restart # Restart
175
+ octoally status # Show version, channel, and update info
176
+ octoally update # Check for and apply updates
177
+ octoally channel [name] # Switch release channel (stable/beta/canary)
178
+ octoally logs # Tail server logs
179
+ octoally install-service # Install as systemd/launchd service (auto-start)
180
+ octoally uninstall-service # Remove the system service
181
+ ```
182
+
183
+ ---
184
+
185
+ ## Architecture
186
+
187
+ ```
188
+ ┌──────────────────────┐ WebSocket ┌─────────────────────────┐
189
+ │ Dashboard (React) │ <────────────────> │ Server (Fastify) │
190
+ │ Vite + Tailwind │ │ SQLite + WebSocket │
191
+ │ TanStack Query │ │ │
192
+ │ Zustand │ │ PTY Worker │
193
+ └──────────────────────┘ │ ├── tmux sessions │
194
+ │ ├── Claude Code │
195
+ ┌──────────────────────┐ │ ├── RuFlo agents │
196
+ │ Desktop (Electron) │ │ └── Terminal shells │
197
+ │ System tray │ <────────────────> │ │
198
+ │ Speech-to-text │ └─────────────────────────┘
199
+ └──────────────────────┘
200
+ ```
201
+
202
+ | Layer | Stack |
203
+ |-------|-------|
204
+ | **Frontend** | React 19, Vite, Tailwind CSS 4, TanStack Query, Zustand, xterm.js |
205
+ | **Backend** | Fastify, TypeScript, SQLite (better-sqlite3), node-pty, WebSocket |
206
+ | **Desktop** | Electron, system tray, local Whisper STT, AES-256-GCM config encryption |
207
+ | **Sessions** | tmux for persistence, dtach for detach/reattach, Claude Code + RuFlo |
208
+
209
+ ---
210
+
211
+ ## Project Structure
212
+
213
+ ```
214
+ octoally/
215
+ ├── server/ # Fastify backend
216
+ │ └── src/
217
+ │ ├── routes/ # REST API endpoints
218
+ │ ├── services/ # Session manager, PTY worker, state tracking
219
+ │ └── db/ # SQLite schema and migrations
220
+ ├── dashboard/ # React frontend
221
+ │ └── src/
222
+ │ ├── components/ # UI components
223
+ │ └── lib/ # API client, stores, utilities
224
+ ├── desktop-electron/ # Electron desktop app
225
+ │ └── src/
226
+ │ └── speech/ # Whisper STT integration
227
+ ├── bin/ # CLI launcher
228
+ └── scripts/ # Install, release, build-archive, update, and service scripts
229
+ ```
230
+
231
+ ---
232
+
233
+ ## Configuration
234
+
235
+ Copy `.env.example` to `.env` in the project root:
236
+
237
+ ```bash
238
+ cp .env.example .env
239
+ ```
240
+
241
+ | Variable | Default | Description |
242
+ |----------|---------|-------------|
243
+ | `PORT` | `42010` | Server port |
244
+ | `OCTOALLY_TOKEN` | *(none)* | Auth token for API/WebSocket — leave empty for local use |
245
+ | `DB_PATH` | `~/.octoally/octoally.db` | SQLite database path |
246
+ | `LOG_LEVEL` | `info` | Log verbosity (`trace` / `debug` / `info` / `warn` / `error`) |
247
+ | `OCTOALLY_USE_TMUX` | `true` | Use tmux for session management |
248
+ | `OCTOALLY_USE_DTACH` | `true` | Use dtach for session persistence |
249
+
250
+ ---
251
+
252
+ ## Desktop App
253
+
254
+ The Electron desktop app adds:
255
+ - System tray with quick server access
256
+ - Automatic server lifecycle management
257
+ - Local speech-to-text via Whisper (no cloud needed)
258
+ - Cloud STT via OpenAI Whisper API or Groq (API keys encrypted at rest)
259
+
260
+ The desktop app is offered during installation, or can be downloaded from [GitHub Releases](https://github.com/ai-genius-automations/octoally/releases).
261
+
262
+ ---
263
+
264
+ ## Contributing
265
+
266
+ Contributions are welcome! Please open an issue or pull request.
267
+
268
+ 1. Fork the repo
269
+ 2. Create a feature branch (`git checkout -b feature/my-feature`)
270
+ 3. Commit your changes
271
+ 4. Push and open a PR
272
+
273
+ ---
274
+
275
+ ## License
276
+
277
+ **Apache License 2.0 with Commons Clause** — see [LICENSE](LICENSE) for full details.
278
+
279
+ You are free to use, modify, and distribute OctoAlly. You may use it as a tool in your workflow to build products you charge for. However, you may not sell products or services whose value derives substantially from OctoAlly itself. Any product that incorporates OctoAlly source code must be distributed free of charge.
280
+
281
+ Copyright 2025 [AI Genius Automations](https://aigeniusautomations.com)
package/cli.mjs ADDED
@@ -0,0 +1,134 @@
1
+ #!/usr/bin/env node
2
+ // OctoAlly CLI — thin npm wrapper
3
+ // Installs OctoAlly from GitHub releases, then proxies commands to the local CLI.
4
+
5
+ import { execSync, spawn } from "node:child_process";
6
+ import { existsSync, mkdirSync, writeFileSync, readFileSync } from "node:fs";
7
+ import { homedir } from "node:os";
8
+ import { join } from "node:path";
9
+ import { createInterface } from "node:readline";
10
+
11
+ const INSTALL_DIR = process.env.OCTOALLY_INSTALL_DIR || join(homedir(), "octoally");
12
+ const GITHUB_REPO = "ai-genius-automations/octoally";
13
+ const LOCAL_CLI = join(INSTALL_DIR, "bin", "octoally");
14
+
15
+ const CYAN = "\x1b[36m";
16
+ const GREEN = "\x1b[32m";
17
+ const YELLOW = "\x1b[33m";
18
+ const RED = "\x1b[31m";
19
+ const BOLD = "\x1b[1m";
20
+ const NC = "\x1b[0m";
21
+
22
+ function log(color, msg) {
23
+ console.log(`${color}[OctoAlly]${NC} ${msg}`);
24
+ }
25
+
26
+ function isInstalled() {
27
+ return existsSync(LOCAL_CLI) && existsSync(join(INSTALL_DIR, "server", "dist"));
28
+ }
29
+
30
+ async function getLatestVersion() {
31
+ const res = await fetch(`https://api.github.com/repos/${GITHUB_REPO}/releases?per_page=5`);
32
+ if (!res.ok) throw new Error(`GitHub API error: ${res.status}`);
33
+ const releases = await res.json();
34
+ const stable = releases.find((r) => !r.draft && !r.prerelease) || releases[0];
35
+ if (!stable) throw new Error("No releases found");
36
+ return { tag: stable.tag_name, version: stable.tag_name.replace(/^v/, ""), url: stable.html_url };
37
+ }
38
+
39
+ async function install() {
40
+ log(CYAN, "Installing OctoAlly...");
41
+ log(CYAN, `Install directory: ${INSTALL_DIR}`);
42
+
43
+ // Check prerequisites
44
+ try {
45
+ execSync("node --version", { stdio: "pipe" });
46
+ } catch {
47
+ log(RED, "Node.js is required. Install it from https://nodejs.org");
48
+ process.exit(1);
49
+ }
50
+
51
+ // Get latest release
52
+ log(CYAN, "Fetching latest release...");
53
+ const { version } = await getLatestVersion();
54
+ log(CYAN, `Latest version: v${version}`);
55
+
56
+ // Clone and build
57
+ if (!existsSync(INSTALL_DIR)) {
58
+ log(CYAN, "Cloning repository...");
59
+ execSync(`git clone --depth 1 https://github.com/${GITHUB_REPO}.git "${INSTALL_DIR}"`, {
60
+ stdio: "inherit",
61
+ });
62
+ } else {
63
+ log(CYAN, "Updating existing installation...");
64
+ execSync("git pull --ff-only", { cwd: INSTALL_DIR, stdio: "inherit" });
65
+ }
66
+
67
+ // Install dependencies
68
+ log(CYAN, "Installing dependencies...");
69
+ execSync("npm install", { cwd: INSTALL_DIR, stdio: "inherit" });
70
+ execSync("npm install", { cwd: join(INSTALL_DIR, "server"), stdio: "inherit" });
71
+ execSync("npm install", { cwd: join(INSTALL_DIR, "dashboard"), stdio: "inherit" });
72
+
73
+ // Build
74
+ log(CYAN, "Building...");
75
+ execSync("npm run build", { cwd: INSTALL_DIR, stdio: "inherit" });
76
+
77
+ // Symlink CLI to PATH
78
+ const binDir = join(homedir(), ".local", "bin");
79
+ mkdirSync(binDir, { recursive: true });
80
+ const symlinkTarget = join(binDir, "octoally");
81
+ try {
82
+ execSync(`ln -sf "${LOCAL_CLI}" "${symlinkTarget}"`, { stdio: "pipe" });
83
+ log(GREEN, `Symlinked to ${symlinkTarget}`);
84
+ } catch {
85
+ log(YELLOW, `Could not create symlink at ${symlinkTarget}`);
86
+ }
87
+
88
+ log(GREEN, `OctoAlly v${version} installed successfully!`);
89
+ log(CYAN, `Start with: octoally start`);
90
+ log(CYAN, `Dashboard: http://localhost:42010`);
91
+ }
92
+
93
+ function proxyCommand(args) {
94
+ const child = spawn(LOCAL_CLI, args, {
95
+ stdio: "inherit",
96
+ cwd: INSTALL_DIR,
97
+ });
98
+ child.on("exit", (code) => process.exit(code ?? 0));
99
+ child.on("error", (err) => {
100
+ log(RED, `Failed to run: ${err.message}`);
101
+ process.exit(1);
102
+ });
103
+ }
104
+
105
+ // Main
106
+ const args = process.argv.slice(2);
107
+ const command = args[0] || "help";
108
+
109
+ if (command === "install" || !isInstalled()) {
110
+ if (!isInstalled()) {
111
+ log(YELLOW, "OctoAlly is not installed yet.");
112
+ const rl = createInterface({ input: process.stdin, output: process.stdout });
113
+ const answer = await new Promise((resolve) => {
114
+ rl.question(`${BOLD}Install to ${INSTALL_DIR}? [Y/n]:${NC} `, resolve);
115
+ });
116
+ rl.close();
117
+ if (answer.toLowerCase() === "n") {
118
+ log(CYAN, "Installation cancelled.");
119
+ process.exit(0);
120
+ }
121
+ }
122
+ try {
123
+ await install();
124
+ // If there were additional args beyond "install", run them
125
+ if (command !== "install" && command !== "help") {
126
+ proxyCommand(args);
127
+ }
128
+ } catch (err) {
129
+ log(RED, `Installation failed: ${err.message}`);
130
+ process.exit(1);
131
+ }
132
+ } else {
133
+ proxyCommand(args);
134
+ }
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "name": "octoally",
3
+ "version": "1.0.7",
4
+ "description": "AI coding session orchestration dashboard — launch, monitor, and manage Claude Code & OpenAI Codex sessions from a web UI",
5
+ "type": "module",
6
+ "bin": {
7
+ "octoally": "cli.mjs"
8
+ },
9
+ "files": [
10
+ "cli.mjs",
11
+ "README.md",
12
+ "LICENSE"
13
+ ],
14
+ "keywords": [
15
+ "claude-code",
16
+ "codex",
17
+ "ai",
18
+ "dashboard",
19
+ "terminal",
20
+ "orchestration",
21
+ "multi-agent",
22
+ "developer-tools",
23
+ "cli"
24
+ ],
25
+ "scripts": {
26
+ "dev": "concurrently \"npm run dev:server\" \"npm run dev:dashboard\"",
27
+ "dev:server": "cd server && npm run dev",
28
+ "dev:dashboard": "cd dashboard && npm run dev",
29
+ "build": "npm run build:dashboard && npm run build:server",
30
+ "build:server": "cd server && npm run build",
31
+ "build:dashboard": "cd dashboard && npm run build",
32
+ "start": "cd server && npm start",
33
+ "install:all": "npm install && cd server && npm install && cd ../dashboard && npm install",
34
+ "clean": "cd server && rm -rf dist && cd ../dashboard && rm -rf dist"
35
+ },
36
+ "devDependencies": {
37
+ "@modelcontextprotocol/sdk": "^1.27.1",
38
+ "better-sqlite3": "^12.8.0",
39
+ "concurrently": "^9.1.0"
40
+ },
41
+ "author": "AI Genius Automations <support@aigeniusautomations.com>",
42
+ "license": "Apache-2.0 WITH Commons-Clause",
43
+ "homepage": "https://octoally.com",
44
+ "repository": {
45
+ "type": "git",
46
+ "url": "git+https://github.com/ai-genius-automations/octoally.git"
47
+ },
48
+ "dependencies": {
49
+ "@xterm/addon-web-links": "^0.12.0"
50
+ }
51
+ }