git-worm 0.1.0__tar.gz

git_worm-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+on:
+  schedule:
+    - cron: "0 0 1 * *" # Run every month
+  # This way, we can make sure code doesn't break via external dependencies
+  push:
+  pull_request:
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version:
+          - "3.12"
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Install just
+        uses: extractions/setup-just@v2
+      - name: Install dependencies
+        run: just install
+      - name: Run test suite
+        run: just test
+      - name: Upload to CodeCov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install just
+        uses: extractions/setup-just@v2
+      - name: Build project
+        run: just build

git_worm-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release Asset Uploader
+on:
+  release:
+    types:
+      - created
+permissions:
+  contents: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+      - name: Build artifacts
+        run: uv build
+      - name: Upload artifacts
+        uses: shogo82148/actions-upload-release-asset@v1
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: dist/*
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

git_worm-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.DS_Store
+docs/superpowers/

git_worm-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

git_worm-0.1.0/Justfile

@@ -0,0 +1,29 @@
+default: test
+
+# Run the test suite
+test *args:
+    uv run pytest {{ args }}
+
+# Run tests with coverage report
+cov:
+    uv run pytest --cov=src/xclif --cov-report=term-missing
+
+# Build the HTML docs
+docs:
+    uv run sphinx-build docs docs/_build/html
+
+# Serve docs locally with live reload
+docs-serve:
+    uv run sphinx-autobuild docs docs/_build/html
+
+# Build the distribution (wheel + sdist)
+build:
+    uv build
+
+# Remove build artifacts
+clean:
+    rm -rf dist docs/_build
+
+# Install all dependency groups
+install:
+    uv sync --all-groups

git_worm-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

git_worm-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: git-worm
+Version: 0.1.0
+Summary: A better git worktree manager
+Project-URL: Homepage, https://github.com/ThatXliner/git-worm
+Project-URL: Repository, https://github.com/ThatXliner/git-worm
+Project-URL: Issues, https://github.com/ThatXliner/git-worm/issues
+Author-email: Bryan Hu <thatxliner@gmail.com>
+License-Expression: Unlicense
+License-File: LICENSE
+Keywords: cli,git,worktree
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.12
+Requires-Dist: xclif>=0.4.0
+Description-Content-Type: text/markdown
+
+# git-worm
+
+> Git WORktree Manager
+
+[![CI](https://github.com/ThatXliner/git-worm/actions/workflows/ci.yml/badge.svg)](https://github.com/ThatXliner/git-worm/actions/workflows/ci.yml)
+
+https://github.com/user-attachments/assets/916af237-e959-43fc-9046-067929ad874f
+
+A better git worktree manager. Built with [Xclif](https://github.com/ThatXliner/xclif).
+
+## Why?
+
+`git worktree` is powerful but raw. git-worm adds:
+
+- **Automatic file management** — gitignored files (`.env`, `.venv`, `node_modules`, etc.) are copied into new worktrees so switching feels like `git switch`
+- **Smart package manager detection** — pnpm/bun/Yarn PnP users don't get unnecessary `node_modules` copies
+- **Nice UI** — Rich-formatted output, tree views, colored status. You can also create multiple worktrees in one command!
+
+## Install
+
+Requires Python 3.12+
+
+```bash
+pip install git-worm
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv tool install git-worm
+```
+
+## Usage
+
+Because of [Xclif](https://github.com/ThatXliner/xclif), git-worm automatically gets a very nice-looking help page
+
+![Help](./help.png)
+
+```bash
+# Create a new worktree (copies .env, .venv, etc. automatically)
+git worm new feat-login
+
+# Create from a specific ref
+git worm new feat-login --from-ref main
+
+# List all worktrees
+git worm list
+
+# Print worktree path
+git worm switch feat-login
+
+# Remove a worktree
+git worm rm feat-login
+
+# Remove even if dirty
+git worm rm feat-login --force
+
+# Shell integration (add to .bashrc/.zshrc)
+eval "$(git-worm shell-init)"
+# Then: worm switch feat-login  (auto-cds)
+```
+
+### Shell integration
+
+`git-worm shell-init` outputs a `worm` shell function that wraps `git-worm`. This is needed because `worm switch` needs to `cd` into the worktree directory, which a plain subprocess can't do. All other commands are forwarded to `git-worm` as-is.
+
+Add this to your `.bashrc` or `.zshrc`:
+
+```bash
+eval "$(git-worm shell-init)"
+```
+
+Then use `worm` instead of `git-worm`:
+
+```bash
+worm new feat-login
+worm switch feat-login  # cds into the worktree
+worm list
+```
+
+## Configuration
+
+Optional `.git-worm.toml` in your repo root:
+
+```toml
+[settings]
+worktree_dir = ".worktrees"  # default
+
+[[share]]
+path = ".env*"
+strategy = "copy"
+
+[[share]]
+path = "node_modules"
+strategy = "ignore"
+
+[[share]]
+path = "target"
+strategy = "symlink"
+```
+
+Strategies: `copy`, `reflink` (COW, falls back to copy), `symlink`, `ignore`.
+
+When a config file is present, it replaces the default behavior entirely.
+
+## Default Behavior (no config)
+
+1. All gitignored files/dirs are detected
+2. `.git/` and `.worktrees/` are excluded
+3. Files are plain-copied, directories are reflinked (with copy fallback)
+4. `node_modules/` is skipped if pnpm, bun, or Yarn PnP is detected
+
+## License
+
+Public Domain

git_worm-0.1.0/README.md

@@ -0,0 +1,115 @@
+# git-worm
+
+> Git WORktree Manager
+
+[![CI](https://github.com/ThatXliner/git-worm/actions/workflows/ci.yml/badge.svg)](https://github.com/ThatXliner/git-worm/actions/workflows/ci.yml)
+
+https://github.com/user-attachments/assets/916af237-e959-43fc-9046-067929ad874f
+
+A better git worktree manager. Built with [Xclif](https://github.com/ThatXliner/xclif).
+
+## Why?
+
+`git worktree` is powerful but raw. git-worm adds:
+
+- **Automatic file management** — gitignored files (`.env`, `.venv`, `node_modules`, etc.) are copied into new worktrees so switching feels like `git switch`
+- **Smart package manager detection** — pnpm/bun/Yarn PnP users don't get unnecessary `node_modules` copies
+- **Nice UI** — Rich-formatted output, tree views, colored status. You can also create multiple worktrees in one command!
+
+## Install
+
+Requires Python 3.12+
+
+```bash
+pip install git-worm
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv tool install git-worm
+```
+
+## Usage
+
+Because of [Xclif](https://github.com/ThatXliner/xclif), git-worm automatically gets a very nice-looking help page
+
+![Help](./help.png)
+
+```bash
+# Create a new worktree (copies .env, .venv, etc. automatically)
+git worm new feat-login
+
+# Create from a specific ref
+git worm new feat-login --from-ref main
+
+# List all worktrees
+git worm list
+
+# Print worktree path
+git worm switch feat-login
+
+# Remove a worktree
+git worm rm feat-login
+
+# Remove even if dirty
+git worm rm feat-login --force
+
+# Shell integration (add to .bashrc/.zshrc)
+eval "$(git-worm shell-init)"
+# Then: worm switch feat-login  (auto-cds)
+```
+
+### Shell integration
+
+`git-worm shell-init` outputs a `worm` shell function that wraps `git-worm`. This is needed because `worm switch` needs to `cd` into the worktree directory, which a plain subprocess can't do. All other commands are forwarded to `git-worm` as-is.
+
+Add this to your `.bashrc` or `.zshrc`:
+
+```bash
+eval "$(git-worm shell-init)"
+```
+
+Then use `worm` instead of `git-worm`:
+
+```bash
+worm new feat-login
+worm switch feat-login  # cds into the worktree
+worm list
+```
+
+## Configuration
+
+Optional `.git-worm.toml` in your repo root:
+
+```toml
+[settings]
+worktree_dir = ".worktrees"  # default
+
+[[share]]
+path = ".env*"
+strategy = "copy"
+
+[[share]]
+path = "node_modules"
+strategy = "ignore"
+
+[[share]]
+path = "target"
+strategy = "symlink"
+```
+
+Strategies: `copy`, `reflink` (COW, falls back to copy), `symlink`, `ignore`.
+
+When a config file is present, it replaces the default behavior entirely.
+
+## Default Behavior (no config)
+
+1. All gitignored files/dirs are detected
+2. `.git/` and `.worktrees/` are excluded
+3. Files are plain-copied, directories are reflinked (with copy fallback)
+4. `node_modules/` is skipped if pnpm, bun, or Yarn PnP is detected
+
+## License
+
+Public Domain

git_worm-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "git-worm"
+version = "0.1.0"
+description = "A better git worktree manager"
+readme = "README.md"
+license = "Unlicense"
+requires-python = ">=3.12"
+authors = [
+    { name = "Bryan Hu", email = "thatxliner@gmail.com" },
+]
+keywords = ["git", "worktree", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: The Unlicense (Unlicense)",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = [
+    "xclif>=0.4.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/ThatXliner/git-worm"
+Repository = "https://github.com/ThatXliner/git-worm"
+Issues = "https://github.com/ThatXliner/git-worm/issues"
+
+[project.scripts]
+git-worm = "git_worm.__main__:cli"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/git_worm"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=7.1.0",
+]

git_worm-0.1.0/src/git_worm/__main__.py

@@ -0,0 +1,8 @@
+from xclif import Cli
+
+from . import routes
+
+cli = Cli.from_routes(routes, local_config=".git-worm.toml")
+
+if __name__ == "__main__":
+    cli()

git_worm-0.1.0/src/git_worm/config.py

@@ -0,0 +1,35 @@
+"""Parse .git-worm.toml configuration."""
+
+from __future__ import annotations
+
+import tomllib
+from dataclasses import dataclass, field
+from pathlib import Path
+
+
+@dataclass(frozen=True)
+class ShareRule:
+    path: str
+    strategy: str  # "copy", "reflink", "symlink", "ignore"
+
+
+@dataclass
+class Config:
+    worktree_dir: str = ".worktrees"
+    share_rules: list[ShareRule] = field(default_factory=list)
+
+
+def load_config(path: Path) -> Config | None:
+    """Load config from a TOML file. Returns None if file doesn't exist."""
+    if not path.exists():
+        return None
+    with open(path, "rb") as f:
+        data = tomllib.load(f)
+    share_rules = [
+        ShareRule(path=rule["path"], strategy=rule["strategy"])
+        for rule in data.get("share", [])
+    ]
+    return Config(
+        worktree_dir=data.get("worktree_dir", ".worktrees"),
+        share_rules=share_rules,
+    )