@ts47andres/exeggutor 1.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2024] [Akshat Sharma]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,230 @@
+<p align="center">
+  <img src="assets/Dashboard.png" alt="Exeggutor Dashboard" width="100%">
+</p>
+
+<p align="center">
+  <strong>Exeggutor</strong> — <em>Terminal Multiplexer & Git Worktree Manager</em><br>
+  Local-first, subscription-free workspace orchestration dashboard.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/node-%3E%3D18.0.0-339933?logo=node.js&logoColor=white" alt="Node">
+  <img src="https://img.shields.io/badge/typescript-3178C6?logo=typescript&logoColor=white" alt="TypeScript">
+  <img src="https://img.shields.io/badge/react-61DAFB?logo=react&logoColor=black" alt="React">
+  <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License">
+</p>
+
+---
+
+## Features
+
+| | |
+|---|---|
+| **Multi-Workspace Engine** | Switch projects and automatically swap terminal grids, paths, and configurations. |
+| **Tabbed Terminal Grid** | Spawn unlimited terminals, split horizontally/vertically, persist sessions across restarts. |
+| **Observer Sidebar** | Real-time terminal state monitoring (Active, Waiting, Idle, Errored) with live text previews. |
+| **Git Worktree Isolation** | Run terminals inside branch-isolated worktree folders — no checkout overhead, no conflicts. |
+| **Remote Access** | Expose the dashboard over your Tailscale tailnet via `--tailscale` flag. |
+| **Persistent State** | Workspaces, terminals, and layouts survive server restarts and package upgrades. |
+
+---
+
+## Screenshots
+
+### Workspace Management
+
+<p align="center">
+  <img src="assets/Workspaces.png" alt="Workspace Selector" width="70%">
+</p>
+
+Switch between registered workspaces, each with its own terminal grid, path mapping, and branch configuration.
+
+### Git Branch Selector
+
+<p align="center">
+  <img src="assets/Branches.png" alt="Branch Selector" width="70%">
+</p>
+
+Create and switch branches per-terminal. New branches automatically spin up an isolated git worktree — zero context switching.
+
+### Zero-State Onboarding
+
+<p align="center">
+  <img src="assets/ZeroState.png" alt="Zero State" width="60%">
+</p>
+
+A clean welcome screen guides you through registering your first workspace and getting started in seconds.
+
+### Mobile View
+
+<p align="center">
+  <img src="assets/MobileView.png" alt="Mobile" width="40%">
+</p>
+
+Responsive layout with a slide-out sidebar drawer and single-terminal tabbed view for on-the-go access.
+
+---
+
+## Architecture
+
+```
+┌──────────────────────────────────────────────────────┐
+│                   Exeggutor CLI                        │
+│  (bin/exeggutor.js — server lifecycle, flags, tasks)  │
+└──────────┬───────────────────────────────────────────┘
+           │ starts / stops
+┌──────────▼───────────────────────────────────────────┐
+│                 Backend (Fastify)                      │
+│  Node.js + Fastify + WebSocket + node-pty             │
+│  ┌────────────┐ ┌──────────┐ ┌─────────────────┐     │
+│  │  Workspace  │ │  PTY     │ │  Git Worktree   │     │
+│  │  Manager    │ │  Manager  │ │  Manager        │     │
+│  └────────────┘ └──────────┘ └─────────────────┘     │
+│  ┌──────────────────────────────────────────────┐     │
+│  │  Tailscale Detection (optional)               │     │
+│  │  --tailscale flag → bind 0.0.0.0             │     │
+│  │  /api/tailscale/status → frontend badge      │     │
+│  └──────────────────────────────────────────────┘     │
+└──────────┬───────────────────────────────────────────┘
+           │ HTTP / WebSocket
+           │  127.0.0.1:17492 (normal)
+           │  <tailscale-ip>:17492 (remote)
+┌──────────▼───────────────────────────────────────────┐
+│               Frontend (Vite + React)                  │
+│  xterm.js · react-mosaic-component · Tailwind CSS    │
+│  Terminal Grid · Observer Sidebar · Branch UI        │
+│  Tailscale IP badge (when --tailscale mode active)   │
+└──────────────────────────────────────────────────────┘
+```
+
+### Stack
+
+| Layer | Technology |
+|---|---|
+| Frontend | Vite · React · TypeScript · Tailwind CSS · xterm.js · react-mosaic-component |
+| Backend | Node.js · Fastify · Fastify WebSocket · node-pty |
+| State | Persistent JSON (`~/.exeggutor-sessions.json`) |
+
+---
+
+## Getting Started
+
+```bash
+# Install globally
+npm install -g @ts47andres/exeggutor
+
+# Start the dashboard
+exeggutor
+
+# Open in browser
+exeggutor --open
+
+# Stop the server
+exeggutor --stop
+
+# Check server status
+exeggutor --status
+```
+
+Once the dashboard loads, register a project directory with a name and path, and you're ready to go.
+
+---
+
+## Remote Access (Tailscale)
+
+Exeggutor can be exposed securely over your [Tailscale](https://tailscale.com) tailnet, allowing you to access the dashboard from any device on your tailnet via a browser.
+
+```bash
+# Start with Tailscale remote access enabled
+exeggutor --tailscale
+```
+
+This binds the server to `0.0.0.0` and makes it reachable at `http://<tailscale-ip>:17492` from any device on your tailnet. The frontend header shows a Tailscale IP badge (with copy-to-clipboard) when in this mode.
+
+### Authenticating from a Remote Browser
+
+When accessing from a remote device (e.g., phone browser), you'll see an authentication page. To sign in:
+
+```bash
+# On the host machine, print the auth token
+exeggutor --show-token
+```
+
+Copy the token and paste it into the input field on the authentication page, then click **Submit**. The token is stored in your browser's localStorage so you only need to do this once per browser.
+
+> **Note:** Tailscale must be installed and connected on the host machine. The badge only appears when `--tailscale` mode is active.
+
+---
+
+## CLI Reference
+
+### Server Lifecycle
+
+| Command | Description |
+|---|---|
+| `exeggutor` or `exeggutor --start` | Start servers in background (normal mode, localhost only) |
+| `exeggutor --stop` or `exeggutor --kill` | Stop all running servers |
+| `exeggutor --restart` | Restart all servers |
+| `exeggutor --status` or `exeggutor -s` | Show server status and workspace list |
+| `exeggutor --open` | Open dashboard in default browser |
+| `exeggutor --log` | Show recent server logs |
+| `exeggutor --version` or `exeggutor -v` | Show version |
+| `exeggutor --help` or `exeggutor -h` | Show help |
+
+### Remote Access
+
+| Command | Description |
+|---|---|
+| `exeggutor --tailscale` | Start with Tailscale remote access enabled |
+| `exeggutor --show-token` | Print the auth token for remote browser login |
+
+### Workspace Management
+
+| Command | Description |
+|---|---|
+| `exeggutor --workspaces` or `exeggutor -w` | List all workspaces |
+| `exeggutor --create-workspace <name> <path>` | Register a new workspace |
+| `exeggutor --delete-workspace <hash>` | Delete a workspace and all its terminals |
+
+### Terminal Management
+
+| Command | Description |
+|---|---|
+| `exeggutor --terminals <hash>` | List terminals in a workspace |
+| `exeggutor --add-terminal <hash> [name]` | Add a new terminal to a workspace |
+| `exeggutor --rename <ws-hash> <term-hash> <new-name>` | Rename a terminal |
+| `exeggutor --close <ws-hash> <term-name-or-hash>` | Close a terminal |
+
+### Service Management
+
+| Command | Description |
+|---|---|
+| `exeggutor --install-service` | Install auto-start on system boot |
+| `exeggutor --remove-service` | Remove auto-start service |
+
+---
+
+## Data Persistence
+
+| File | Location | Purpose |
+|---|---|---|
+| `~/.exeggutor.json` | User home directory | Runtime configuration (port, auth token, backend PID) |
+| `~/.exeggutor-sessions.json` | User home directory | Workspaces, terminals, and layout state |
+| `~/.exeggutor-logs/` | User home directory | Server log files |
+| `~/.exeggutor-worktrees/` | User home directory | Temporary git worktree directories |
+
+Data survives server restarts, package upgrades, and uninstall/reinstall cycles.
+
+---
+
+## Development
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for coding conventions, comment rules, and local-first principles.
+
+```bash
+# Build all packages
+npm run build
+
+# Start in development mode
+npm run dev
+```

package/bin/exeggutor.js

@@ -0,0 +1,217 @@
+#!/usr/bin/env node
+
+// Exeggutor CLI entry point.
+// Parses command-line arguments and dispatches to the appropriate handler.
+
+const { resolve } = require('path');
+const { existsSync, readFileSync } = require('fs');
+const cli = require('../src/cli');
+
+// Resolve the package root to locate workspaces and config.
+const ROOT = resolve(__dirname, '..');
+
+// Determine the active config from home directory.
+const CONFIG_PATH = resolve(require('os').homedir(), '.exeggutor.json');
+
+const args = process.argv.slice(2);
+const first = args[0] || '';
+
+// --version
+if (first === '--version' || first === '-v') {
+  cli.showVersion(ROOT);
+  process.exit(0);
+}
+
+// --help
+if (first === '--help' || first === '-h') {
+  cli.showHelp();
+  process.exit(0);
+}
+
+// --tailscale (start with Tailscale mode)
+if (first === '--tailscale') {
+  const extraArgs = args.slice(1);
+  extraArgs.push('--tailscale');
+  cli.startServers(ROOT, CONFIG_PATH, extraArgs).catch(err => {
+    console.error('Fatal error starting servers:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --start (default if no recognized flag or no args)
+if (first === '--start' || !first || (first && !first.startsWith('--'))) {
+  const passive = first === '--start';
+  const extraArgs = passive ? args.slice(1) : args;
+  cli.startServers(ROOT, CONFIG_PATH, extraArgs).catch(err => {
+    console.error('Fatal error starting servers:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --stop / --kill
+if (first === '--stop' || first === '--kill') {
+  cli.stopServers(CONFIG_PATH);
+  process.exit(0);
+}
+
+// --restart
+if (first === '--restart') {
+  cli.restartServers(ROOT, CONFIG_PATH).catch(err => {
+    console.error('Fatal error restarting servers:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --status
+if (first === '--status' || first === '-s') {
+  cli.showStatus(CONFIG_PATH).catch(err => {
+    console.error('Failed to get status:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --open
+if (first === '--open') {
+  cli.openDashboard(CONFIG_PATH).catch(err => {
+    console.error('Failed to open dashboard:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --log
+if (first === '--log') {
+  cli.showLogs(CONFIG_PATH);
+  process.exit(0);
+}
+
+// --workspaces
+if (first === '--workspaces' || first === '-w') {
+  cli.listWorkspaces(CONFIG_PATH).catch(err => {
+    console.error('Failed to list workspaces:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --terminals <workspace-hash>
+if (first === '--terminals') {
+  const wsHash = args[1];
+  if (!wsHash) {
+    console.error('Usage: exeggutor --terminals <workspace-hash>');
+    process.exit(1);
+  }
+  cli.listTerminals(CONFIG_PATH, wsHash).catch(err => {
+    console.error('Failed to list terminals:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --create-workspace <name> <path>
+if (first === '--create-workspace') {
+  const name = args[1];
+  const wsPath = args[2];
+  if (!name || !wsPath) {
+    console.error('Usage: exeggutor --create-workspace <name> <absolute-path>');
+    process.exit(1);
+  }
+  cli.createWorkspace(CONFIG_PATH, name, wsPath).catch(err => {
+    console.error('Failed to create workspace:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --add-terminal <workspace-hash> <name>
+if (first === '--add-terminal') {
+  const wsHash = args[1];
+  const termName = args[2] || `Terminal`;
+  if (!wsHash) {
+    console.error('Usage: exeggutor --add-terminal <workspace-hash> [name]');
+    process.exit(1);
+  }
+  cli.addTerminal(CONFIG_PATH, wsHash, termName).catch(err => {
+    console.error('Failed to add terminal:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --rename <workspace-hash> <terminal-hash> <new-name>
+if (first === '--rename') {
+  const wsHash = args[1];
+  const termHash = args[2];
+  const newName = args[3];
+  if (!wsHash || !termHash || !newName) {
+    console.error('Usage: exeggutor --rename <workspace-hash> <terminal-hash> <new-name>');
+    process.exit(1);
+  }
+  cli.renameTerminal(CONFIG_PATH, wsHash, termHash, newName).catch(err => {
+    console.error('Failed to rename terminal:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --close <workspace-hash> <terminal-name-or-hash>
+if (first === '--close') {
+  const wsHash = args[1];
+  const termId = args[2];
+  if (!wsHash || !termId) {
+    console.error('Usage: exeggutor --close <workspace-hash> <terminal-name-or-hash>');
+    process.exit(1);
+  }
+  cli.closeTerminal(CONFIG_PATH, wsHash, termId).catch(err => {
+    console.error('Failed to close terminal:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --delete-workspace <workspace-hash>
+if (first === '--delete-workspace') {
+  const wsHash = args[1];
+  if (!wsHash) {
+    console.error('Usage: exeggutor --delete-workspace <workspace-hash>');
+    process.exit(1);
+  }
+  cli.deleteWorkspace(CONFIG_PATH, wsHash).catch(err => {
+    console.error('Failed to delete workspace:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --install-service
+if (first === '--install-service') {
+  cli.installAutostart(ROOT).catch(err => {
+    console.error('Failed to install autostart service:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --remove-service
+if (first === '--remove-service') {
+  cli.removeAutostart().catch(err => {
+    console.error('Failed to remove autostart service:', err.message);
+    process.exit(1);
+  });
+  return;
+}
+
+// --show-token
+if (first === '--show-token') {
+  cli.showToken(CONFIG_PATH);
+  process.exit(0);
+}
+
+// Unknown command
+console.error(`Unknown command: ${first}`);
+console.error('Run "exeggutor --help" for usage information.');
+process.exit(1);