git-ssh-sync 0.1.0__tar.gz → 0.2.0__tar.gz

{git_ssh_sync-0.1.0 → git_ssh_sync-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: git-ssh-sync
-Version: 0.1.0
+Version: 0.2.0
 Summary: Sync Git commits through a local machine for development environments without direct GitHub or GitLab access.
 Requires-Dist: pydantic>=2.13.4
 Requires-Dist: pyyaml>=6.0.3
@@ -21,6 +21,8 @@ Description-Content-Type: text/markdown
 
 `git-ssh-sync` is a CLI tool for synchronizing Git commits created in a development environment that cannot directly access GitHub/GitLab to external Git services via a local machine.
 
+This tool is designed for niche environments where outbound network access is restricted, such as high-security enterprises and projects that only allow limited inbound communication (e.g., SSH, RDP).
+
 This is not a file synchronization tool. It synchronizes Git objects and branches. Source editing, building, testing, and committing are performed in the development environment, while communication with GitHub/GitLab is handled by the local machine.
 
 ## Prerequisites
@@ -113,6 +115,28 @@ git-ssh-sync init myproject \
   --force
 ```
 
+You can inspect and maintain registered projects without opening the config file directly.
+
+```bash
+# List registered projects
+git-ssh-sync config list
+
+# Show all settings for one project
+git-ssh-sync config show myproject
+
+# Update selected settings
+git-ssh-sync config set myproject \
+  --origin git@github.com:example/myproject.git \
+  --dev-host devserver \
+  --dev-path /home/user/work/myproject
+
+# Remove a project after confirmation
+git-ssh-sync config remove myproject
+
+# Remove a project without an interactive prompt
+git-ssh-sync config remove myproject --yes
+```
+
 ## Initial Workflow
 
 For the first time, execute configuration, clone to the development environment, and diagnostics in order.
@@ -244,6 +268,12 @@ git-ssh-sync init myproject \
   --dev-user user \
   --dev-path /home/user/work/myproject
 
+# List registered project settings
+git-ssh-sync config list
+
+# Show registered project settings
+git-ssh-sync config show myproject
+
 # Initial clone
 git-ssh-sync clone myproject
 
@@ -277,6 +307,16 @@ To develop this repository itself, install dependencies using `uv sync`.
 uv sync
 ```
 
+To install from TestPyPI:
+
+```bash
+uv tool install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  --index-strategy unsafe-best-match \
+  git-ssh-sync
+```
+
 To execute the CLI during development, you can run it via `uv run`.
 
 ```bash

{git_ssh_sync-0.1.0 → git_ssh_sync-0.2.0}/README.md

@@ -10,6 +10,8 @@
 
 `git-ssh-sync` is a CLI tool for synchronizing Git commits created in a development environment that cannot directly access GitHub/GitLab to external Git services via a local machine.
 
+This tool is designed for niche environments where outbound network access is restricted, such as high-security enterprises and projects that only allow limited inbound communication (e.g., SSH, RDP).
+
 This is not a file synchronization tool. It synchronizes Git objects and branches. Source editing, building, testing, and committing are performed in the development environment, while communication with GitHub/GitLab is handled by the local machine.
 
 ## Prerequisites
@@ -102,6 +104,28 @@ git-ssh-sync init myproject \
   --force
 ```
 
+You can inspect and maintain registered projects without opening the config file directly.
+
+```bash
+# List registered projects
+git-ssh-sync config list
+
+# Show all settings for one project
+git-ssh-sync config show myproject
+
+# Update selected settings
+git-ssh-sync config set myproject \
+  --origin git@github.com:example/myproject.git \
+  --dev-host devserver \
+  --dev-path /home/user/work/myproject
+
+# Remove a project after confirmation
+git-ssh-sync config remove myproject
+
+# Remove a project without an interactive prompt
+git-ssh-sync config remove myproject --yes
+```
+
 ## Initial Workflow
 
 For the first time, execute configuration, clone to the development environment, and diagnostics in order.
@@ -233,6 +257,12 @@ git-ssh-sync init myproject \
   --dev-user user \
   --dev-path /home/user/work/myproject
 
+# List registered project settings
+git-ssh-sync config list
+
+# Show registered project settings
+git-ssh-sync config show myproject
+
 # Initial clone
 git-ssh-sync clone myproject
 
@@ -266,6 +296,16 @@ To develop this repository itself, install dependencies using `uv sync`.
 uv sync
 ```
 
+To install from TestPyPI:
+
+```bash
+uv tool install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  --index-strategy unsafe-best-match \
+  git-ssh-sync
+```
+
 To execute the CLI during development, you can run it via `uv run`.
 
 ```bash

{git_ssh_sync-0.1.0 → git_ssh_sync-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-ssh-sync"
-version = "0.1.0"
+version = "0.2.0"
 description = "Sync Git commits through a local machine for development environments without direct GitHub or GitLab access."
 readme = "README.md"
 requires-python = ">=3.12"

{git_ssh_sync-0.1.0 → git_ssh_sync-0.2.0}/src/git_ssh_sync/cli.py

@@ -4,15 +4,22 @@ from typing import Annotated
 
 import typer
 from rich.markup import escape
+from rich.table import Table
 
 from git_ssh_sync import __version__
 from git_ssh_sync.branch import BranchError, branch_project
 from git_ssh_sync.clone import CloneError, clone_project
 from git_ssh_sync.config import (
     ConfigError,
+    NoConfigUpdateError,
     ProjectAlreadyExistsError,
+    get_project,
+    list_project_names,
     default_config_path,
     init_project,
+    load_config,
+    remove_project,
+    update_project,
 )
 from git_ssh_sync.console import console
 from git_ssh_sync.doctor import DoctorError, doctor_project
@@ -25,6 +32,8 @@ app = typer.Typer(
     help="Sync Git commits through a local machine over SSH.",
     no_args_is_help=True,
 )
+config_app = typer.Typer(help="Manage registered project configuration.")
+app.add_typer(config_app, name="config")
 
 
 def _version_callback(value: bool) -> None:
@@ -55,6 +64,152 @@ def _not_implemented(command: str, project: str | None = None) -> None:
     )
 
 
+@config_app.command("list")
+def config_list_command() -> None:
+    """List registered projects."""
+    try:
+        config = load_config()
+    except ConfigError as error:
+        console.print(f"[red]{escape(str(error))}[/red]")
+        raise typer.Exit(code=1) from error
+
+    names = list_project_names(config)
+    if not names:
+        console.print("No projects configured.")
+        return
+
+    console.print("Configured projects:")
+    for name in names:
+        project_config = config.projects[name]
+        console.print(f"- {escape(name)}")
+        console.print(f"  origin: {escape(project_config.origin)}")
+        console.print(f"  local repo: {escape(project_config.local.repo_path)}")
+        console.print(f"  dev host: {escape(project_config.dev.host)}")
+        console.print(f"  dev path: {escape(project_config.dev.work_path)}")
+
+
+@config_app.command("show")
+def config_show_command(
+    project: Annotated[str, typer.Argument(help="Project name to show.")],
+) -> None:
+    """Show one registered project configuration."""
+    try:
+        project_config = get_project(load_config(), project)
+    except ConfigError as error:
+        console.print(f"[red]{escape(str(error))}[/red]")
+        raise typer.Exit(code=1) from error
+
+    table = Table(title=f"Project configuration: {escape(project)}")
+    table.add_column("Section", overflow="fold")
+    table.add_column("Name", overflow="fold")
+    table.add_column("Value", overflow="fold")
+    table.add_row("project", "name", escape(project))
+    table.add_row("origin", "url", escape(project_config.origin))
+    table.add_row("local", "repo_path", escape(project_config.local.repo_path))
+    table.add_row("dev", "host", escape(project_config.dev.host))
+    table.add_row("dev", "user", escape(project_config.dev.user))
+    table.add_row("dev", "work_path", escape(project_config.dev.work_path))
+    table.add_row("dev", "cache_path", escape(project_config.dev.cache_path))
+    table.add_row("options", "sync_tags", str(project_config.options.sync_tags))
+    table.add_row("options", "lfs", str(project_config.options.lfs))
+    table.add_row("options", "submodules", str(project_config.options.submodules))
+    table.add_row("options", "ff_only", str(project_config.options.ff_only))
+    console.print(table)
+
+
+@config_app.command("remove")
+def config_remove_command(
+    project: Annotated[str, typer.Argument(help="Project name to remove.")],
+    yes: Annotated[
+        bool,
+        typer.Option("--yes", "-y", help="Remove without confirmation."),
+    ] = False,
+) -> None:
+    """Remove a registered project configuration."""
+    if not yes and not typer.confirm(f"Remove project '{project}'?"):
+        console.print("Aborted.")
+        raise typer.Exit(code=1)
+
+    try:
+        remove_project(project)
+    except ConfigError as error:
+        console.print(f"[red]{escape(str(error))}[/red]")
+        raise typer.Exit(code=1) from error
+
+    console.print(f"Project '{project}' removed from {default_config_path()}")
+
+
+@config_app.command("set")
+def config_set_command(
+    project: Annotated[str, typer.Argument(help="Project name to update.")],
+    origin: Annotated[
+        str | None,
+        typer.Option("--origin", help="Origin Git URL."),
+    ] = None,
+    local_repo_path: Annotated[
+        str | None,
+        typer.Option("--local-repo-path", help="Local gateway repository path."),
+    ] = None,
+    dev_host: Annotated[
+        str | None,
+        typer.Option("--dev-host", help="Development environment SSH host."),
+    ] = None,
+    dev_user: Annotated[
+        str | None,
+        typer.Option("--dev-user", help="Development environment SSH user."),
+    ] = None,
+    dev_path: Annotated[
+        str | None,
+        typer.Option(
+            "--dev-path", help="Development environment work repository path."
+        ),
+    ] = None,
+    dev_cache_path: Annotated[
+        str | None,
+        typer.Option("--dev-cache-path", help="Development cache repository path."),
+    ] = None,
+    sync_tags: Annotated[
+        bool | None,
+        typer.Option("--sync-tags/--no-sync-tags", help="Enable or disable tag sync."),
+    ] = None,
+    lfs: Annotated[
+        bool | None,
+        typer.Option("--lfs/--no-lfs", help="Enable or disable Git LFS handling."),
+    ] = None,
+    submodules: Annotated[
+        bool | None,
+        typer.Option(
+            "--submodules/--no-submodules",
+            help="Enable or disable submodule handling.",
+        ),
+    ] = None,
+    ff_only: Annotated[
+        bool | None,
+        typer.Option("--ff-only/--no-ff-only", help="Enable or disable ff-only sync."),
+    ] = None,
+) -> None:
+    """Update one or more fields in a registered project configuration."""
+    try:
+        update_project(
+            project,
+            origin=origin,
+            local_repo_path=local_repo_path,
+            dev_host=dev_host,
+            dev_user=dev_user,
+            dev_work_path=dev_path,
+            dev_cache_path=dev_cache_path,
+            sync_tags=sync_tags,
+            lfs=lfs,
+            submodules=submodules,
+            ff_only=ff_only,
+        )
+    except (ConfigError, NoConfigUpdateError) as error:
+        console.print(f"[red]{escape(str(error))}[/red]")
+        raise typer.Exit(code=1) from error
+
+    console.print(f"Project '{project}' updated in {default_config_path()}")
+
+
 @app.command("init")
 def init_command(
     project: Annotated[str, typer.Argument(help="Project name to register.")],

{git_ssh_sync-0.1.0 → git_ssh_sync-0.2.0}/src/git_ssh_sync/config.py

@@ -23,6 +23,10 @@ class ProjectNotFoundError(ConfigError):
     """Raised when a project is not registered."""
 
 
+class NoConfigUpdateError(ConfigError):
+    """Raised when no project configuration updates were provided."""
+
+
 def _expand_path(value: str) -> str:
     return str(Path(value).expanduser())
 
@@ -127,6 +131,91 @@ def get_project(config: AppConfig, project: str) -> ProjectConfig:
         raise ProjectNotFoundError(f"Project '{project}' is not configured.") from error
 
 
+def list_project_names(config: AppConfig) -> list[str]:
+    """Return configured project names sorted for stable CLI output."""
+    return sorted(config.projects)
+
+
+def remove_project(
+    project: str,
+    *,
+    config_path: Path | None = None,
+) -> None:
+    """Remove a project from config.yaml."""
+    config = load_config(config_path)
+    get_project(config, project)
+    projects = dict(config.projects)
+    del projects[project]
+    save_config(config.model_copy(update={"projects": projects}), config_path)
+
+
+def update_project(
+    project: str,
+    *,
+    origin: str | None = None,
+    local_repo_path: str | None = None,
+    dev_host: str | None = None,
+    dev_user: str | None = None,
+    dev_work_path: str | None = None,
+    dev_cache_path: str | None = None,
+    sync_tags: bool | None = None,
+    lfs: bool | None = None,
+    submodules: bool | None = None,
+    ff_only: bool | None = None,
+    config_path: Path | None = None,
+) -> ProjectConfig:
+    """Partially update an existing project in config.yaml."""
+    config = load_config(config_path)
+    current = get_project(config, project)
+    raw = current.model_dump(mode="json")
+
+    updated = False
+    if origin is not None:
+        raw["origin"] = origin
+        updated = True
+    if local_repo_path is not None:
+        raw["local"]["repo_path"] = local_repo_path
+        updated = True
+    if dev_host is not None:
+        raw["dev"]["host"] = dev_host
+        updated = True
+    if dev_user is not None:
+        raw["dev"]["user"] = dev_user
+        updated = True
+    if dev_work_path is not None:
+        raw["dev"]["work_path"] = dev_work_path
+        updated = True
+    if dev_cache_path is not None:
+        raw["dev"]["cache_path"] = dev_cache_path
+        updated = True
+
+    for key, value in {
+        "sync_tags": sync_tags,
+        "lfs": lfs,
+        "submodules": submodules,
+        "ff_only": ff_only,
+    }.items():
+        if value is not None:
+            raw["options"][key] = value
+            updated = True
+
+    if not updated:
+        raise NoConfigUpdateError("Specify at least one setting to update.")
+
+    try:
+        updated_project = ProjectConfig.model_validate(raw)
+    except ValidationError as error:
+        raise ConfigError(
+            format_validation_error_for_project(project, error)
+        ) from error
+
+    save_config(
+        register_project(config, project, updated_project, force=True),
+        config_path,
+    )
+    return updated_project
+
+
 def build_project_config(
     project: str,
     *,