@aku11i/phantom 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shuhei Akutagawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+# 👻 Phantom
+
+<div align="center">
+
+**A powerful CLI tool for seamless parallel development with Git worktrees**
+
+[![npm version](https://img.shields.io/npm/v/@aku11i/phantom.svg)](https://www.npmjs.com/package/@aku11i/phantom)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/node/v/@aku11i/phantom.svg)](https://nodejs.org)
+
+[Installation](#-installation) • [Quick Start](#-quick-start) • [Why Phantom?](#-why-phantom) • [Documentation](#-documentation)
+
+</div>
+
+## ✨ Key Features
+
+- 🚀 **Simplified Worktree Management** - Create and manage Git worktrees with intuitive commands
+- 🔄 **Seamless Context Switching** - Jump between different features without stashing or committing
+- 🤖 **AI-Friendly** - Perfect for running multiple AI coding agents in parallel
+- 🎯 **Branch-Worktree Sync** - Automatically creates matching branches for each worktree
+- 🐚 **Interactive Shell** - SSH-like experience for worktree navigation
+- ⚡ **Zero Configuration** - Works out of the box with sensible defaults
+
+## 🤔 Why Phantom?
+
+Modern development workflows often require working on multiple features simultaneously. Whether you're running AI coding agents in parallel, reviewing PRs while developing, or simply multitasking across features, managing multiple Git worktrees can be cumbersome.
+
+**The Problem:**
+- Git worktree commands are verbose and complex
+- Managing branches and worktrees separately is error-prone
+- Switching contexts requires multiple commands
+- Running parallel AI agents on the same codebase is challenging
+
+**The Phantom Solution:**
+- One command to create both worktree and branch: `phantom garden create feature-x`
+- Instant context switching: `phantom shell feature-x`
+- Execute commands without changing directories: `phantom exec feature-x npm test`
+- Perfect for "parallel vibe coding" with multiple AI agents
+
+## 🚀 Quick Start
+
+```bash
+# Install Phantom
+npm install -g @aku11i/phantom
+
+# Create a new development space (garden)
+phantom garden create feature-awesome
+
+# Jump into the new space
+phantom shell feature-awesome
+
+# Or execute commands directly
+phantom exec feature-awesome npm install
+phantom exec feature-awesome npm test
+
+# List all your gardens
+phantom garden list
+
+# Clean up when done
+phantom garden delete feature-awesome
+```
+
+## 📦 Installation
+
+### Using npm (recommended)
+```bash
+npm install -g @aku11i/phantom
+```
+
+### Using pnpm
+```bash
+pnpm add -g @aku11i/phantom
+```
+
+### Using yarn
+```bash
+yarn global add @aku11i/phantom
+```
+
+### Build from source
+```bash
+git clone https://github.com/aku11i/phantom.git
+cd phantom
+pnpm install
+npm link
+```
+
+## 📖 Documentation
+
+### Core Concepts
+
+**Gardens** 🌳 - Git worktrees managed by Phantom. Each garden is an isolated workspace for a specific branch or feature.
+
+**Phantoms** 👻 - Processes or agents that work within gardens.
+
+### Commands Overview
+
+#### Gardens Management
+
+```bash
+# Create a new garden with a matching branch
+phantom garden create <name>
+
+# List all gardens with their current status
+phantom garden list
+
+# Get the absolute path to a garden
+phantom garden where <name>
+
+# Delete a garden and its branch
+phantom garden delete <name>
+phantom garden delete <name> --force  # Force delete with uncommitted changes
+```
+
+#### Working with Gardens
+
+```bash
+# Execute any command in a garden's context
+phantom exec <garden> <command> [args...]
+
+# Examples:
+phantom exec feature-auth npm install
+phantom exec feature-auth npm run test
+phantom exec feature-auth git status
+
+# Open an interactive shell session in a garden
+phantom shell <garden>
+```
+
+### Environment Variables
+
+When working within a Phantom context, these environment variables are available:
+
+- `PHANTOM_GARDEN` - Name of the current garden
+- `PHANTOM_GARDEN_PATH` - Absolute path to the garden directory
+
+## 🔄 Phantom vs Git Worktree
+
+| Feature | Git Worktree | Phantom |
+|---------|--------------|---------|
+| Create worktree + branch | `git worktree add -b feature ../project-feature` | `phantom garden create feature` |
+| List worktrees | `git worktree list` | `phantom garden list` |
+| Navigate to worktree | `cd ../project-feature` | `phantom shell feature` |
+| Run command in worktree | `cd ../project-feature && npm test` | `phantom exec feature npm test` |
+| Remove worktree | `git worktree remove ../project-feature` | `phantom garden delete feature` |
+
+## 🛠️ Development
+
+```bash
+# Clone and setup
+git clone https://github.com/aku11i/phantom.git
+cd phantom
+pnpm install
+
+# Run tests
+pnpm test
+
+# Type checking
+pnpm type-check
+
+# Linting
+pnpm lint
+
+# Run all checks
+pnpm ready
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to:
+- Update tests as appropriate
+- Follow the existing code style
+- Run `pnpm ready` before submitting
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Inspired by the need for better parallel development workflows
+- Built for the AI-assisted development era
+- Special thanks to all contributors
+
+---
+
+<div align="center">
+Made with 👻 by <a href="https://github.com/aku11i">aku11i</a>
+</div>

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@aku11i/phantom",
+  "version": "0.1.0",
+  "description": "A CLI tool for managing Git worktrees (gardens) with enhanced functionality",
+  "keywords": [
+    "git",
+    "worktree",
+    "cli",
+    "phantom",
+    "gardens",
+    "workspace",
+    "development"
+  ],
+  "homepage": "https://github.com/aku11i/phantom#readme",
+  "bugs": {
+    "url": "https://github.com/aku11i/phantom/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aku11i/phantom.git"
+  },
+  "license": "MIT",
+  "author": "aku11i",
+  "type": "module",
+  "bin": {
+    "phantom": "./src/bin/phantom.ts",
+    "garden": "./src/bin/garden.ts"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.15.29",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "start": "node ./src/bin/phantom.ts",
+    "phantom": "node ./src/bin/phantom.ts",
+    "garden": "node ./src/bin/garden.ts",
+    "type-check": "tsc --noEmit",
+    "test": "node --test --experimental-test-module-mocks src/**/*.test.ts",
+    "lint": "biome check .",
+    "fix": "biome check --write .",
+    "ready": "pnpm fix && pnpm type-check && pnpm test",
+    "ready:check": "pnpm lint && pnpm type-check && pnpm test"
+  }
+}

package/src/bin/garden.ts

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+import { argv, exit } from "node:process";
+import { gardensCreateHandler } from "../gardens/commands/create.ts";
+import { gardensDeleteHandler } from "../gardens/commands/delete.ts";
+import { gardensListHandler } from "../gardens/commands/list.ts";
+import { gardensWhereHandler } from "../gardens/commands/where.ts";
+
+interface Command {
+  name: string;
+  description: string;
+  handler?: (args: string[]) => void | Promise<void>;
+}
+
+const commands: Command[] = [
+  {
+    name: "create",
+    description: "Create a new worktree (garden)",
+    handler: gardensCreateHandler,
+  },
+  {
+    name: "list",
+    description: "List all gardens",
+    handler: gardensListHandler,
+  },
+  {
+    name: "where",
+    description: "Output the path of a specific garden",
+    handler: gardensWhereHandler,
+  },
+  {
+    name: "delete",
+    description: "Delete a garden (use --force for dirty gardens)",
+    handler: gardensDeleteHandler,
+  },
+];
+
+function printHelp() {
+  console.log("Usage: garden <command> [options]\n");
+  console.log("Commands:");
+  for (const cmd of commands) {
+    console.log(`  ${cmd.name.padEnd(20)} ${cmd.description}`);
+  }
+  console.log("\nThis is an alias for 'phantom garden' commands.");
+}
+
+function findCommand(cmdName: string, commands: Command[]): Command | null {
+  return commands.find((cmd) => cmd.name === cmdName) || null;
+}
+
+const args = argv.slice(2);
+
+if (args.length === 0 || args[0] === "-h" || args[0] === "--help") {
+  printHelp();
+  exit(0);
+}
+
+const command = findCommand(args[0], commands);
+
+if (!command || !command.handler) {
+  console.error(`Error: Unknown command '${args[0]}'\n`);
+  printHelp();
+  exit(1);
+}
+
+try {
+  await command.handler(args.slice(1));
+} catch (error) {
+  console.error(
+    "Error:",
+    error instanceof Error ? error.message : String(error),
+  );
+  exit(1);
+}

package/src/bin/phantom.ts

@@ -0,0 +1,121 @@
+#!/usr/bin/env node
+
+import { argv, exit } from "node:process";
+import { execHandler } from "../commands/exec.ts";
+import { shellHandler } from "../commands/shell.ts";
+import { gardensCreateHandler } from "../gardens/commands/create.ts";
+import { gardensDeleteHandler } from "../gardens/commands/delete.ts";
+import { gardensListHandler } from "../gardens/commands/list.ts";
+import { gardensWhereHandler } from "../gardens/commands/where.ts";
+
+interface Command {
+  name: string;
+  description: string;
+  subcommands?: Command[];
+  handler?: (args: string[]) => void | Promise<void>;
+}
+
+const commands: Command[] = [
+  {
+    name: "garden",
+    description: "Manage git worktrees (gardens)",
+    subcommands: [
+      {
+        name: "create",
+        description: "Create a new worktree (garden)",
+        handler: gardensCreateHandler,
+      },
+      {
+        name: "list",
+        description: "List all gardens",
+        handler: gardensListHandler,
+      },
+      {
+        name: "where",
+        description: "Output the path of a specific garden",
+        handler: gardensWhereHandler,
+      },
+      {
+        name: "delete",
+        description: "Delete a garden (use --force for dirty gardens)",
+        handler: gardensDeleteHandler,
+      },
+    ],
+  },
+  {
+    name: "exec",
+    description: "Execute a command in a garden directory",
+    handler: execHandler,
+  },
+  {
+    name: "shell",
+    description: "Open interactive shell in a garden directory",
+    handler: shellHandler,
+  },
+];
+
+function printHelp(commands: Command[], prefix = "") {
+  console.log("Usage: phantom <command> [options]\n");
+  console.log("Commands:");
+  for (const cmd of commands) {
+    console.log(`  ${prefix}${cmd.name.padEnd(20)} ${cmd.description}`);
+    if (cmd.subcommands) {
+      for (const subcmd of cmd.subcommands) {
+        console.log(`    ${subcmd.name.padEnd(18)} ${subcmd.description}`);
+      }
+    }
+  }
+}
+
+function findCommand(
+  args: string[],
+  commands: Command[],
+): { command: Command | null; remainingArgs: string[] } {
+  if (args.length === 0) {
+    return { command: null, remainingArgs: [] };
+  }
+
+  const [cmdName, ...rest] = args;
+  const command = commands.find((cmd) => cmd.name === cmdName);
+
+  if (!command) {
+    return { command: null, remainingArgs: args };
+  }
+
+  if (command.subcommands && rest.length > 0) {
+    const { command: subcommand, remainingArgs } = findCommand(
+      rest,
+      command.subcommands,
+    );
+    if (subcommand) {
+      return { command: subcommand, remainingArgs };
+    }
+  }
+
+  return { command, remainingArgs: rest };
+}
+
+const args = argv.slice(2);
+
+if (args.length === 0 || args[0] === "-h" || args[0] === "--help") {
+  printHelp(commands);
+  exit(0);
+}
+
+const { command, remainingArgs } = findCommand(args, commands);
+
+if (!command || !command.handler) {
+  console.error(`Error: Unknown command '${args.join(" ")}'\n`);
+  printHelp(commands);
+  exit(1);
+}
+
+try {
+  await command.handler(remainingArgs);
+} catch (error) {
+  console.error(
+    "Error:",
+    error instanceof Error ? error.message : String(error),
+  );
+  exit(1);
+}