sprout-cli 0.2.0__tar.gz → 0.3.0__tar.gz

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sprout-cli
-Version: 0.2.0
+Version: 0.3.0
 Summary: CLI tool to automate git worktree and Docker Compose development workflows
 Author: SecDevLab Inc.
 License: MIT
@@ -71,35 +71,94 @@ DB_PORT={{ auto_port() }}
 # DB_NAME=${DB_NAME}
 ```
 
-2. Create a new development environment:
+2. Create and navigate to a new development environment in one command:
 ```bash
-sprout create feature-branch
+cd $(sprout create feature-branch --path)
 ```
 
-3. Navigate to your new environment:
+This single command:
+- Creates a new git worktree for `feature-branch`
+- Generates a `.env` file from your template
+- Outputs the path to the new environment
+- Changes to that directory when wrapped in `cd $(...)`
+
+3. Start your services:
 ```bash
-cd $(sprout path feature-branch)
+docker compose up -d
 ```
 
-4. Start your services:
+### Alternative: Two-Step Process
+
+If you prefer to see the creation output first:
 ```bash
-docker compose up -d
+# Create the environment
+sprout create feature-branch
+
+# Then navigate to it
+cd $(sprout path feature-branch)
 ```
 
 ## Commands
 
-### `sprout create <branch-name>`
+### `sprout create <branch-name> [--path]`
 Create a new development environment with automated setup.
 
+Options:
+- `--path`: Output only the worktree path (useful for shell command substitution)
+
+Examples:
+```bash
+# Create and see progress messages
+sprout create feature-xyz
+
+# Create and navigate in one command
+cd $(sprout create feature-xyz --path)
+```
+
 ### `sprout ls`
 List all managed development environments with their status.
 
-### `sprout rm <branch-name>`
+The output includes index numbers that can be used with other commands:
+```bash
+sprout ls
+# Output:
+# ┏━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
+# ┃ No.  ┃ Branch          ┃ Path            ┃ Status ┃ Last Modified    ┃
+# ┡━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
+# │ 1    │ feature-auth    │ .sprout/feat... │        │ 2025-06-27 14:30 │
+# │ 2    │ bugfix-api      │ .sprout/bugf... │        │ 2025-06-27 15:45 │
+# └──────┴─────────────────┴─────────────────┴────────┴──────────────────┘
+```
+
+### `sprout rm <branch-name-or-index>`
 Remove a development environment (with confirmation prompts).
 
-### `sprout path <branch-name>`
+You can use either the branch name or the index number from `sprout ls`:
+```bash
+# Remove by branch name
+sprout rm feature-auth
+
+# Remove by index number
+sprout rm 1
+```
+
+### `sprout path <branch-name-or-index>`
 Get the filesystem path of a development environment.
 
+You can use either the branch name or the index number from `sprout ls`:
+```bash
+# Get path by branch name
+sprout path feature-auth
+# Output: /path/to/project/.sprout/feature-auth
+
+# Get path by index number
+sprout path 1
+# Output: /path/to/project/.sprout/feature-auth
+
+# Use with cd command
+cd $(sprout path 2)
+```
+
 ### `sprout --version`
 Show the version of sprout.
 

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/README.md

@@ -43,35 +43,94 @@ DB_PORT={{ auto_port() }}
 # DB_NAME=${DB_NAME}
 ```
 
-2. Create a new development environment:
+2. Create and navigate to a new development environment in one command:
 ```bash
-sprout create feature-branch
+cd $(sprout create feature-branch --path)
 ```
 
-3. Navigate to your new environment:
+This single command:
+- Creates a new git worktree for `feature-branch`
+- Generates a `.env` file from your template
+- Outputs the path to the new environment
+- Changes to that directory when wrapped in `cd $(...)`
+
+3. Start your services:
 ```bash
-cd $(sprout path feature-branch)
+docker compose up -d
 ```
 
-4. Start your services:
+### Alternative: Two-Step Process
+
+If you prefer to see the creation output first:
 ```bash
-docker compose up -d
+# Create the environment
+sprout create feature-branch
+
+# Then navigate to it
+cd $(sprout path feature-branch)
 ```
 
 ## Commands
 
-### `sprout create <branch-name>`
+### `sprout create <branch-name> [--path]`
 Create a new development environment with automated setup.
 
+Options:
+- `--path`: Output only the worktree path (useful for shell command substitution)
+
+Examples:
+```bash
+# Create and see progress messages
+sprout create feature-xyz
+
+# Create and navigate in one command
+cd $(sprout create feature-xyz --path)
+```
+
 ### `sprout ls`
 List all managed development environments with their status.
 
-### `sprout rm <branch-name>`
+The output includes index numbers that can be used with other commands:
+```bash
+sprout ls
+# Output:
+# ┏━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
+# ┃ No.  ┃ Branch          ┃ Path            ┃ Status ┃ Last Modified    ┃
+# ┡━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
+# │ 1    │ feature-auth    │ .sprout/feat... │        │ 2025-06-27 14:30 │
+# │ 2    │ bugfix-api      │ .sprout/bugf... │        │ 2025-06-27 15:45 │
+# └──────┴─────────────────┴─────────────────┴────────┴──────────────────┘
+```
+
+### `sprout rm <branch-name-or-index>`
 Remove a development environment (with confirmation prompts).
 
-### `sprout path <branch-name>`
+You can use either the branch name or the index number from `sprout ls`:
+```bash
+# Remove by branch name
+sprout rm feature-auth
+
+# Remove by index number
+sprout rm 1
+```
+
+### `sprout path <branch-name-or-index>`
 Get the filesystem path of a development environment.
 
+You can use either the branch name or the index number from `sprout ls`:
+```bash
+# Get path by branch name
+sprout path feature-auth
+# Output: /path/to/project/.sprout/feature-auth
+
+# Get path by index number
+sprout path 1
+# Output: /path/to/project/.sprout/feature-auth
+
+# Use with cd command
+cd $(sprout path 2)
+```
+
 ### `sprout --version`
 Show the version of sprout.
 

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/pyproject.toml

@@ -122,4 +122,10 @@ ignore_missing_imports = true
 [[tool.mypy.overrides]]
 module = "tests.*"
 disallow_untyped_defs = false
-disallow_incomplete_defs = false
+disallow_incomplete_defs = false
+
+[dependency-groups]
+dev = [
+    "pytest-mock>=3.14.1",
+    "ruff>=0.12.1",
+]

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/src/sprout/__init__.py

@@ -1,3 +1,3 @@
 """sprout - CLI tool to automate git worktree and Docker Compose development workflows."""
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/src/sprout/cli.py

@@ -46,9 +46,14 @@ def create(
         ...,
         help="Name of the branch to create worktree for",
     ),
+    path: bool = typer.Option(
+        False,
+        "--path",
+        help="Output only the worktree path (for use with shell command substitution)",
+    ),
 ) -> None:
     """Create a new development environment."""
-    create_worktree(branch_name)
+    create_worktree(branch_name, path_only=path)
 
 
 @app.command()
@@ -59,24 +64,24 @@ def ls() -> None:
 
 @app.command()
 def rm(
-    branch_name: BranchName = typer.Argument(
+    identifier: str = typer.Argument(
         ...,
-        help="Name of the branch to remove",
+        help="Branch name or index number to remove",
     ),
 ) -> None:
     """Remove a development environment."""
-    remove_worktree(branch_name)
+    remove_worktree(identifier)
 
 
 @app.command()
 def path(
-    branch_name: BranchName = typer.Argument(
+    identifier: str = typer.Argument(
         ...,
-        help="Name of the branch to get path for",
+        help="Branch name or index number to get path for",
     ),
 ) -> None:
     """Get the path of a development environment."""
-    get_worktree_path(branch_name)
+    get_worktree_path(identifier)
 
 
 if __name__ == "__main__":

sprout_cli-0.3.0/src/sprout/commands/create.py

@@ -0,0 +1,114 @@
+"""Implementation of the create command."""
+
+from pathlib import Path
+from typing import Never
+
+import typer
+from rich.console import Console
+
+from sprout.exceptions import SproutError
+from sprout.types import BranchName
+from sprout.utils import (
+    branch_exists,
+    ensure_sprout_dir,
+    get_git_root,
+    is_git_repository,
+    parse_env_template,
+    run_command,
+    worktree_exists,
+)
+
+console = Console()
+
+
+def create_worktree(branch_name: BranchName, path_only: bool = False) -> Never:
+    """Create a new worktree with development environment."""
+    # Check prerequisites
+    if not is_git_repository():
+        if not path_only:
+            console.print("[red]Error: Not in a git repository[/red]")
+            console.print("Please run this command from the root of a git repository.")
+        else:
+            typer.echo("Error: Not in a git repository", err=True)
+        raise typer.Exit(1)
+
+    git_root = get_git_root()
+    env_example = git_root / ".env.example"
+
+    if not env_example.exists():
+        if not path_only:
+            console.print("[red]Error: .env.example file not found[/red]")
+            console.print(f"Expected at: {env_example}")
+        else:
+            typer.echo(f"Error: .env.example file not found at {env_example}", err=True)
+        raise typer.Exit(1)
+
+    # Check if worktree already exists
+    if worktree_exists(branch_name):
+        if not path_only:
+            console.print(f"[red]Error: Worktree for branch '{branch_name}' already exists[/red]")
+        else:
+            typer.echo(f"Error: Worktree for branch '{branch_name}' already exists", err=True)
+        raise typer.Exit(1)
+
+    # Ensure .sprout directory exists
+    sprout_dir = ensure_sprout_dir()
+    worktree_path = sprout_dir / branch_name
+
+    # Create the worktree
+    if not path_only:
+        console.print(f"Creating worktree for branch [cyan]{branch_name}[/cyan]...")
+
+    # Check if branch exists, create if it doesn't
+    if not branch_exists(branch_name):
+        if not path_only:
+            console.print(f"Branch '{branch_name}' doesn't exist. Creating new branch...")
+        # Create branch with -b flag
+        cmd = ["git", "worktree", "add", "-b", branch_name, str(worktree_path)]
+    else:
+        cmd = ["git", "worktree", "add", str(worktree_path), branch_name]
+
+    try:
+        run_command(cmd)
+    except SproutError as e:
+        if not path_only:
+            console.print(f"[red]Error creating worktree: {e}[/red]")
+        else:
+            typer.echo(f"Error creating worktree: {e}", err=True)
+        raise typer.Exit(1) from e
+
+    # Generate .env file
+    if not path_only:
+        console.print("Generating .env file...")
+    try:
+        env_content = parse_env_template(env_example, silent=path_only)
+        env_file = worktree_path / ".env"
+        env_file.write_text(env_content)
+    except SproutError as e:
+        if not path_only:
+            console.print(f"[red]Error generating .env file: {e}[/red]")
+        else:
+            typer.echo(f"Error generating .env file: {e}", err=True)
+        # Clean up worktree on failure
+        run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
+        raise typer.Exit(1) from e
+    except KeyboardInterrupt:
+        if not path_only:
+            console.print("\n[yellow]Cancelled by user[/yellow]")
+        else:
+            typer.echo("Cancelled by user", err=True)
+        # Clean up worktree on cancellation
+        run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
+        raise typer.Exit(130) from None
+
+    # Success message or path output
+    if path_only:
+        # Output only the path for shell command substitution
+        print(str(worktree_path))
+    else:
+        console.print(f"\n[green]✅ Workspace '{branch_name}' created successfully![/green]\n")
+        console.print("Navigate to your new environment with:")
+        console.print(f"  [cyan]cd {worktree_path.relative_to(Path.cwd())}[/cyan]")
+
+    # Exit successfully
+    raise typer.Exit(0)

sprout_cli-0.3.0/src/sprout/commands/ls.py

@@ -0,0 +1,48 @@
+"""Implementation of the ls command."""
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from sprout.utils import get_indexed_worktrees, is_git_repository
+
+console = Console()
+
+
+def list_worktrees() -> None:
+    """List all managed development environments."""
+    if not is_git_repository():
+        console.print("[red]Error: Not in a git repository[/red]")
+        raise typer.Exit(1)
+
+    try:
+        sprout_worktrees = get_indexed_worktrees()
+    except Exception as e:
+        console.print(f"[red]Error listing worktrees: {e}[/red]")
+        raise typer.Exit(1) from e
+
+    if not sprout_worktrees:
+        console.print("[yellow]No sprout-managed worktrees found.[/yellow]")
+        console.print("Use 'sprout create <branch-name>' to create one.")
+        return None
+
+    # Create table with index column
+    table = Table(title="Sprout Worktrees", show_lines=True)
+    table.add_column("No.", style="bright_white", no_wrap=True, width=4)
+    table.add_column("Branch", style="cyan", no_wrap=True)
+    table.add_column("Path", style="blue")
+    table.add_column("Status", style="green")
+    table.add_column("Last Modified", style="yellow")
+
+    from pathlib import Path
+
+    for idx, wt in enumerate(sprout_worktrees, 1):
+        branch = wt.get("branch", wt.get("head", "detached"))
+        path = str(wt["path"].relative_to(Path.cwd()))
+        status = "[green]● current[/green]" if wt.get("is_current", False) else ""
+        modified_dt = wt.get("modified")
+        modified = modified_dt.strftime("%Y-%m-%d %H:%M") if modified_dt else "N/A"
+
+        table.add_row(str(idx), branch, path, status, modified)
+
+    console.print(table)

sprout_cli-0.3.0/src/sprout/commands/path.py

@@ -0,0 +1,45 @@
+"""Implementation of the path command."""
+
+from typing import Never, TextIO
+
+import typer
+
+from sprout.utils import (
+    get_sprout_dir,
+    is_git_repository,
+    resolve_branch_identifier,
+    worktree_exists,
+)
+
+console: TextIO = typer.get_text_stream("stdout")
+
+
+def get_worktree_path(identifier: str) -> Never:
+    """Get the path of a development environment by branch name or index."""
+    if not is_git_repository():
+        typer.echo("Error: Not in a git repository", err=True)
+        raise typer.Exit(1)
+
+    # Resolve identifier to branch name
+    branch_name = resolve_branch_identifier(identifier)
+
+    if branch_name is None:
+        if identifier.isdigit():
+            typer.echo(
+                f"Error: Invalid index '{identifier}'. Use 'sprout ls' to see valid indices.",
+                err=True,
+            )
+        else:
+            typer.echo(f"Error: Worktree for branch '{identifier}' does not exist", err=True)
+        raise typer.Exit(1)
+
+    # Check if worktree exists
+    if not worktree_exists(branch_name):
+        typer.echo(f"Error: Worktree for branch '{branch_name}' does not exist", err=True)
+        raise typer.Exit(1)
+
+    worktree_path = get_sprout_dir() / branch_name
+
+    # Output only the path, no extra formatting
+    print(str(worktree_path))
+    raise typer.Exit(0)

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/src/sprout/commands/rm.py

@@ -4,10 +4,10 @@ import typer
 from rich.console import Console
 
 from sprout.exceptions import SproutError
-from sprout.types import BranchName
 from sprout.utils import (
     get_sprout_dir,
     is_git_repository,
+    resolve_branch_identifier,
     run_command,
     worktree_exists,
 )
@@ -15,12 +15,25 @@ from sprout.utils import (
 console = Console()
 
 
-def remove_worktree(branch_name: BranchName) -> None:
-    """Remove a development environment."""
+def remove_worktree(identifier: str) -> None:
+    """Remove a development environment by branch name or index."""
     if not is_git_repository():
         console.print("[red]Error: Not in a git repository[/red]")
         raise typer.Exit(1)
 
+    # Resolve identifier to branch name
+    branch_name = resolve_branch_identifier(identifier)
+
+    if branch_name is None:
+        if identifier.isdigit():
+            console.print(
+                f"[red]Error: Invalid index '{identifier}'. "
+                "Use 'sprout ls' to see valid indices.[/red]"
+            )
+        else:
+            console.print(f"[red]Error: Worktree for branch '{identifier}' does not exist[/red]")
+        raise typer.Exit(1)
+
     # Check if worktree exists
     if not worktree_exists(branch_name):
         console.print(f"[red]Error: Worktree for branch '{branch_name}' does not exist[/red]")

{sprout_cli-0.2.0 → sprout_cli-0.3.0}/src/sprout/utils.py

@@ -5,13 +5,15 @@ import random
 import re
 import socket
 import subprocess
+from datetime import datetime
 from pathlib import Path
 from typing import TypeAlias
 
+import typer
 from rich.console import Console
 
 from sprout.exceptions import SproutError
-from sprout.types import BranchName
+from sprout.types import BranchName, WorktreeInfo
 
 # Type aliases
 PortNumber: TypeAlias = int
@@ -123,7 +125,7 @@ def find_available_port() -> PortNumber:
     raise SproutError("Could not find an available port after 1000 attempts")
 
 
-def parse_env_template(template_path: Path) -> str:
+def parse_env_template(template_path: Path, silent: bool = False) -> str:
     """Parse .env.example template and process placeholders."""
     if not template_path.exists():
         raise SproutError(f".env.example file not found at {template_path}")
@@ -155,7 +157,12 @@ def parse_env_template(template_path: Path) -> str:
             value = os.environ.get(var_name)
             if value is None:
                 # Prompt user for value
-                value = console.input(f"Enter a value for '{var_name}': ")
+                if silent:
+                    # Use stderr for prompts in silent mode to keep stdout clean
+                    typer.echo(f"Enter a value for '{var_name}': ", err=True, nl=False)
+                    value = input()
+                else:
+                    value = console.input(f"Enter a value for '{var_name}': ")
             return value
 
         line = re.sub(r"{{\s*([^}]+)\s*}}", replace_variable, line)
@@ -175,3 +182,90 @@ def branch_exists(branch_name: BranchName) -> bool:
     """Check if a git branch exists."""
     result = run_command(["git", "rev-parse", "--verify", f"refs/heads/{branch_name}"], check=False)
     return result.returncode == 0
+
+
+def get_indexed_worktrees() -> list[WorktreeInfo]:
+    """Get a list of sprout-managed worktrees with consistent ordering.
+
+    Returns:
+        List of WorktreeInfo dicts, sorted by branch name for consistent indexing.
+    """
+    if not is_git_repository():
+        raise SproutError("Not in a git repository")
+
+    sprout_dir = get_sprout_dir()
+
+    # Get worktree list from git
+    result = run_command(["git", "worktree", "list", "--porcelain"])
+
+    # Parse worktree output
+    worktrees: list[WorktreeInfo] = []
+    current_worktree: WorktreeInfo = {}
+
+    for line in result.stdout.strip().split("\n"):
+        if not line:
+            if current_worktree:
+                worktrees.append(current_worktree)
+                current_worktree = {}
+            continue
+
+        if line.startswith("worktree "):
+            current_worktree["path"] = Path(line[9:])
+        elif line.startswith("branch "):
+            branch_ref = line[7:]
+            # Strip refs/heads/ prefix if present
+            if branch_ref.startswith("refs/heads/"):
+                current_worktree["branch"] = branch_ref[11:]
+            else:
+                current_worktree["branch"] = branch_ref
+        elif line.startswith("HEAD "):
+            current_worktree["head"] = line[5:]
+
+    if current_worktree:
+        worktrees.append(current_worktree)
+
+    # Filter for sprout-managed worktrees
+    sprout_worktrees: list[WorktreeInfo] = []
+    current_path = Path.cwd().resolve()
+
+    for wt in worktrees:
+        wt_path = wt["path"].resolve()
+        if wt_path.parent == sprout_dir:
+            # Check if we're currently in this worktree
+            wt["is_current"] = current_path == wt_path or current_path.is_relative_to(wt_path)
+
+            # Get last modified time
+            if wt_path.exists():
+                stat = wt_path.stat()
+                wt["modified"] = datetime.fromtimestamp(stat.st_mtime)
+            else:
+                wt["modified"] = None
+
+            sprout_worktrees.append(wt)
+
+    # Sort by branch name for consistent indexing
+    sprout_worktrees.sort(key=lambda wt: wt.get("branch") or wt.get("head") or "")
+
+    return sprout_worktrees
+
+
+def resolve_branch_identifier(identifier: str) -> BranchName | None:
+    """Resolve a branch identifier (name or index) to a branch name.
+
+    Args:
+        identifier: Either a branch name or a 1-based index number
+
+    Returns:
+        Branch name if found, None otherwise
+    """
+    # Check if identifier is a number
+    if identifier.isdigit():
+        index = int(identifier)
+        worktrees = get_indexed_worktrees()
+
+        if 1 <= index <= len(worktrees):
+            return worktrees[index - 1].get("branch", worktrees[index - 1].get("head", ""))
+        return None
+
+    # Otherwise treat as branch name
+    return identifier