git-cai-cli 0.1.0__py3-none-any.whl → 0.1.dev1__py3-none-any.whl

git_cai_cli/__init__.py

@@ -0,0 +1,5 @@
+"""git-cai-cli: AI-powered git commit message generator."""
+
+from ._version import __version__
+
+__all__ = ["__version__"]

git_cai_cli/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.dev1'
+__version_tuple__ = version_tuple = (0, 1, 'dev1')
+
+__commit_id__ = commit_id = None

git_cai_cli/cli/cli.py

@@ -0,0 +1,371 @@
+"""
+CLI entry point for git-cai-cli.
+"""
+
+import logging
+
+import typer
+from git_cai_cli.cli.helptext import print_help_and_exit
+from git_cai_cli.cli.modes import resolve_mode, validate_options
+from git_cai_cli.main import run
+
+log = logging.getLogger(__name__)
+
+app = typer.Typer(add_completion=False, help=None, no_args_is_help=False)
+
+
+@app.callback(invoke_without_command=True)
+def callback(  # pylint: disable=too-many-arguments,too-many-positional-arguments
+    version: bool = typer.Option(
+        False, "-v", "--version", help="Show version", is_eager=True
+    ),
+    help_flag: bool = typer.Option(
+        False, "-h", "--help", help="Show help", is_eager=True
+    ),
+    install_completion: bool = typer.Option(
+        False,
+        "--install-completion",
+        "-i",
+        help="Install shell completion for git-cai",
+        is_eager=True,
+    ),
+    amend: bool = typer.Option(
+        False, "-A", "--amend", help="Regenerate and amend the last commit message"
+    ),
+    branch_context: bool | None = typer.Option(
+        None,
+        "--branch/--no-branch",
+        "-b",
+        help="Include current branch name as context for the LLM. Use --no-branch to explicitly disable when the persisted config has it enabled.",
+    ),
+    conventional: bool | None = typer.Option(
+        None,
+        "--conventional/--no-conventional",
+        "-C",
+        help="Use Conventional Commits format (type(scope): description). Use --no-conventional to explicitly disable when the persisted config has it enabled.",
+    ),
+    crazy: bool = typer.Option(
+        False, "-c", "--crazy", help="Commit immediately without opening editor"
+    ),
+    enable_debug: bool = typer.Option(
+        False, "--debug", "-d", help="Enable debug logging"
+    ),
+    generate_config: bool = typer.Option(
+        False,
+        "-g",
+        "--generate-config",
+        help="Generate default cai_config.yml in the current directory",
+    ),
+    generate_prompts: bool = typer.Option(
+        False,
+        "-p",
+        "--generate-prompts",
+        help="Generate default commit/squash prompt files in the current directory",
+    ),
+    list_flag: bool = typer.Option(
+        False,
+        "--list",
+        "-l",
+        help="List information (e.g. languages, styles, providers, config)",
+        is_flag=True,
+    ),
+    list_arg: str = typer.Argument(
+        None, help="Optional argument for --list or --squash (see docs)"
+    ),
+    stage_tracked: bool = typer.Option(
+        False, "--all", "-a", help="Stage all tracked files"
+    ),
+    squash: bool = typer.Option(
+        False, "--squash", "-s", help="Squash commits on this branch"
+    ),
+    pr: bool = typer.Option(
+        False,
+        "--PR",
+        "-r",
+        help="Generate a Pull Request description from the commits on this branch",
+    ),
+    base: str = typer.Option(
+        None,
+        "--base",
+        help="Explicit base branch for --PR (overrides auto-detection)",
+    ),
+    update: bool = typer.Option(False, "--update", "-u", help="Check for updates"),
+    set_config: str = typer.Option(
+        None,
+        "-S",
+        "--set",
+        help="Set a config value in repo config (key=value). Requires existing repo config.",
+    ),
+    set_home: str = typer.Option(
+        None,
+        "-H",
+        "--set-home",
+        help="Set a config value in home config (key=value). Always targets ~/.config/cai/.",
+    ),
+    provider: str = typer.Option(
+        None, "--provider", "-P", help="Override LLM provider for this invocation"
+    ),
+    model: str = typer.Option(
+        None, "--model", "-m", help="Override model (requires --provider)"
+    ),
+    context: str = typer.Option(
+        None,
+        "-x",
+        "--context",
+        help="Extra context for the LLM (e.g. ticket number, reason for change)",
+    ),
+    time_flag: bool = typer.Option(
+        False, "--time", "-t", help="Measure and log generation time"
+    ),
+    timeout: int = typer.Option(
+        None,
+        "-T",
+        "--timeout",
+        help="HTTP timeout in seconds for this invocation (overrides config; default 30).",
+    ),
+    full_files: bool | None = typer.Option(
+        None,
+        "--full-files/--no-full-files",
+        "-F",
+        help="Send the full contents of affected files alongside the diff. Use --no-full-files to explicitly disable when the persisted config has it enabled.",
+    ),
+    files: list[str] = typer.Option(
+        None,
+        "-f",
+        "--files",
+        help="Limit the diff (and full-file content, if enabled) to these paths. Repeat for multiple files.",
+    ),
+    sql: str = typer.Option(
+        None,
+        "--sql",
+        "-q",
+        help="Override stats writing for this run: --sql true / --sql false. Wins over the persisted `stats` config.",
+    ),
+    stats: bool = typer.Option(
+        False,
+        "--stats",
+        "-z",
+        help="Show local-only usage analytics (commits per provider, token totals, latency).",
+    ),
+    stats_since: str = typer.Option(
+        None,
+        "--since",
+        help="Filter --stats to events on or after this date (YYYY-MM-DD).",
+    ),
+    stats_json: bool = typer.Option(
+        False,
+        "--json",
+        help="Render --stats output as JSON instead of text.",
+    ),
+    stats_reset: bool = typer.Option(
+        False,
+        "--reset-stats",
+        help="Delete all rows from the local stats DB.",
+    ),
+    init: bool = typer.Option(
+        False,
+        "--init",
+        "-I",
+        help="Interactive setup wizard: writes ~/.config/cai/cai_config.yml and tokens.yml.",
+    ),
+    signoff: bool | None = typer.Option(
+        None,
+        "--signoff/--no-signoff",
+        "-o",
+        help="Append a `Signed-off-by:` trailer using git user.name/user.email. Use --no-signoff to disable when the persisted config has it enabled.",
+    ),
+    print_only: bool = typer.Option(
+        False,
+        "--print",
+        help="Generate the commit message, print it to stdout, and exit without committing.",
+    ),
+    temperature: float = typer.Option(
+        None,
+        "-E",
+        "--temperature",
+        help="Override the active provider's sampling temperature for this invocation.",
+    ),
+    style: str = typer.Option(
+        None,
+        "-y",
+        "--style",
+        help="Override the commit message style for this invocation (e.g. funny, neutral, none).",
+    ),
+    language: str = typer.Option(
+        None,
+        "-L",
+        "--language",
+        help="Override the commit message language code for this invocation (e.g. de, fr, none).",
+    ),
+    emoji: bool | None = typer.Option(
+        None,
+        "-e",
+        "--emoji/--no-emoji",
+        help="Override emoji usage for this invocation. Use --no-emoji to disable when config enables it.",
+    ),
+    check: bool = typer.Option(
+        False,
+        "-k",
+        "--check",
+        help="Run configuration diagnostics (offline). Add --ping for a live provider probe.",
+    ),
+    ping: bool = typer.Option(
+        False,
+        "-n",
+        "--ping",
+        help="With --check, also send a tiny request to the active provider to confirm reachability.",
+    ),
+    allow_secrets: bool = typer.Option(
+        False,
+        "-B",
+        "--allow-secrets",
+        help="Bypass the local secret scan and send the diff even if a likely secret is detected.",
+    ),
+):
+    """
+    CLI entry point for git-cai-cli.
+    """
+    if help_flag:
+        print_help_and_exit()
+
+    if version:
+        from git_cai_cli._version import __version__
+
+        typer.echo(f"cai version: {__version__}")
+        raise typer.Exit()
+
+    if install_completion:
+        from git_cai_cli.core.completion import install_completion as do_install
+
+        do_install()
+        raise typer.Exit()
+
+    mode = resolve_mode(
+        amend=amend,
+        check=check,
+        init=init,
+        list_flag=list_flag,
+        pr=pr,
+        squash=squash,
+        stats=stats,
+        update=update,
+    )
+
+    if ping and not check:
+        typer.echo("Error: --ping is only valid together with --check.", err=True)
+        raise typer.Exit(code=1)
+
+    sql_override: bool | None = None
+    if sql is not None:
+        normalized = sql.strip().lower()
+        if normalized in ("true", "1", "yes", "on"):
+            sql_override = True
+        elif normalized in ("false", "0", "no", "off"):
+            sql_override = False
+        else:
+            typer.echo(f"Error: --sql expects true/false, got {sql!r}.", err=True)
+            raise typer.Exit(code=1)
+
+    validate_options(
+        mode=mode,
+        stage_tracked=stage_tracked,
+        enable_debug=enable_debug,
+        help_flag=help_flag,
+        version_flag=version,
+        provider_override=provider,
+        model_override=model,
+        time_flag=time_flag,
+        context=context,
+        files=files,
+        print_only=print_only,
+        crazy=crazy,
+    )
+
+    if generate_config:
+        from git_cai_cli.core.options import CliManager
+
+        manager = CliManager(package_name="git-cai-cli")
+
+        try:
+            manager.generate_config_here()
+            typer.echo("cai_config.yml created in current directory.")
+        except RuntimeError as e:
+            typer.echo(f"Error: {e}", err=True)
+            raise typer.Exit(code=1)
+
+        raise typer.Exit()
+
+    if generate_prompts:
+        from git_cai_cli.core.options import CliManager
+
+        manager = CliManager(package_name="git-cai-cli")
+
+        try:
+            manager.generate_prompts_here()
+            typer.echo(
+                "commit_prompt.md, squash_prompt.md, full_files_prompt.md, "
+                "and pr_prompt.md created in current directory."
+            )
+        except RuntimeError as e:
+            typer.echo(f"Error: {e}", err=True)
+            raise typer.Exit(code=1)
+
+        raise typer.Exit()
+
+    if set_config or set_home:
+        from git_cai_cli.core.config import set_config_value
+        from git_cai_cli.main import configure_logging
+
+        configure_logging(enable_debug)
+
+        raw = set_home if set_home else set_config
+        force_home = set_home is not None
+
+        if "=" not in raw:
+            log.error("Invalid format: expected key=value, got '%s'", raw)
+            raise typer.Exit(code=1)
+
+        key, value = raw.split("=", 1)
+
+        try:
+            target = set_config_value(key, value, force_home=force_home)
+            log.info("Configuration updated: %s = %s in %s", key, value, target)
+        except ValueError as e:
+            log.error("Failed to set config: %s", e)
+            raise typer.Exit(code=1)
+
+        raise typer.Exit()
+
+    run(
+        mode=mode,
+        enable_debug=enable_debug,
+        list_arg=list_arg,
+        stage_tracked=stage_tracked,
+        conventional=conventional,
+        branch_context=branch_context,
+        crazy=crazy,
+        provider_override=provider,
+        model_override=model,
+        time_flag=time_flag,
+        context=context,
+        timeout_override=timeout,
+        full_files_override=full_files,
+        files_override=files,
+        base_override=base,
+        sql_override=sql_override,
+        stats_since=stats_since,
+        stats_json=stats_json,
+        stats_reset=stats_reset,
+        signoff=signoff,
+        print_only=print_only,
+        temperature_override=temperature,
+        style_override=style,
+        language_override=language,
+        emoji_override=emoji,
+        live_check=ping,
+        allow_secrets=allow_secrets,
+    )
+
+
+if __name__ == "__main__":
+    app()

git_cai_cli/cli/helptext.py

@@ -0,0 +1,75 @@
+"""
+Help text for git-cai-cli.
+"""
+
+from pathlib import Path
+
+import typer
+
+HOME = Path.home()
+
+HELP_TEXT = f"""
+Git CAI - AI-powered commit message generator
+
+Usage:
+  git cai        Generate commit message from staged changes
+
+Flags:
+  -A, --amend              Regenerate and amend the last commit message
+  -a, --all                Stage all modified and deleted files that are already tracked by Git
+  -B, --allow-secrets      Bypass the local secret scan and send even if a secret is detected
+  -b, --branch             Include current branch name as context for the LLM
+  -C, --conventional       Use Conventional Commits format (type(scope): description)
+  -c, --crazy              Commit immediately without opening editor (trust LLM output)
+  -d, --debug              Enable debug logging
+  -E, --temperature FLOAT  Override the active provider's sampling temperature for this invocation
+  -e, --emoji              Toggle emoji prefixes (use --no-emoji to disable)
+  -F, --full-files         Send the full contents of affected files alongside the diff
+  -f, --files PATH         Limit the diff (and full files) to PATH; repeat the flag for multiple files
+  -g, --generate-config    Generate default cai_config.yml in the current directory
+  -H, --set-home KEY=VALUE Set a config value in home config (~/.config/cai/)
+  -h, --help               Show this help message or opens manual
+  -I, --init               Interactive setup wizard (writes home config and tokens.yml)
+  -i, --install-completion Install shell completion for git-cai
+  -k, --check              Run configuration diagnostics (offline; add --ping for a live probe)
+  -L, --language CODE      Override the commit message language (e.g. de, fr, none)
+  -l, --list [TYPE]        List information. TYPE: config, editor, language,
+                           model, path, provider, style
+  -m, --model NAME         Override model for this invocation (requires --provider)
+  -n, --ping               With --check, probe the active provider for reachability
+  -o, --signoff            Append a `Signed-off-by:` trailer (git user.name / user.email)
+  -P, --provider NAME      Override LLM provider for this invocation
+  -p, --generate-prompts   Generate default commit/squash/full_files/pr prompt files
+      --print              Print the generated commit message to stdout and exit (no commit)
+  -q, --sql true|false     Override stats writing for this run (wins over config)
+  -r, --PR                 Generate a Pull Request description from the commits on this branch
+      --base BRANCH        Base branch for --PR (overrides auto-detection)
+  -S, --set KEY=VALUE      Set a config value in repo config (requires existing repo config)
+  -s, --squash [N|HASH]    Squash commits on this branch and summarize them
+                           No argument: squash all commits since branch checkout
+                           Number: squash the last N commits
+                           Hash: squash up to and including that commit
+  -T, --timeout SECONDS    HTTP timeout in seconds (overrides config; default 30)
+  -t, --time               Measure and log commit message generation time
+  -u, --update             Check for updates
+  -v, --version            Show installed version
+  -x, --context TEXT       Provide extra context for the LLM (e.g. ticket number, reason)
+  -y, --style NAME         Override the commit message style (e.g. funny, neutral, none)
+  -z, --stats              Show local-only usage analytics (commits, tokens, latency)
+      --since YYYY-MM-DD   Filter --stats to events on or after this date
+      --json               Render --stats output as JSON instead of text
+      --reset-stats        Delete all rows from the local stats DB
+
+Configuration:
+  Tokens are loaded from {HOME}/.config/cai/tokens.yml
+  Reset to default config by deleting {HOME}/.config/cai/cai_config.yml
+  and executing 'git cai' again.
+"""
+
+
+def print_help_and_exit() -> None:
+    """
+    Print help text and exit.
+    """
+    typer.echo(HELP_TEXT)
+    raise typer.Exit()

git_cai_cli/cli/modes.py

@@ -0,0 +1,145 @@
+"""
+Module for handling operational modes and validating command-line options.
+"""
+
+from enum import Enum, auto
+
+import typer
+
+
+class Mode(Enum):
+    """
+    Enum representing the different operational modes of the CLI.
+    """
+
+    AMEND = auto()
+    CHECK = auto()
+    COMMIT = auto()
+    INIT = auto()
+    LIST = auto()
+    PR = auto()
+    SQUASH = auto()
+    STATS = auto()
+    UPDATE = auto()
+
+
+def resolve_mode(
+    *,
+    amend: bool,
+    check: bool = False,
+    init: bool = False,
+    list_flag: bool,
+    pr: bool,
+    squash: bool,
+    stats: bool = False,
+    update: bool,
+) -> Mode:
+    """
+    Resolves the operational mode based on the provided flags.
+    """
+    flags = [amend, check, init, list_flag, pr, squash, stats, update]
+    if sum(flags) > 1:
+        typer.echo(
+            "Error: --amend, --check, --init, --list, --PR, --squash, --stats, and "
+            "--update cannot be used together.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if amend:
+        return Mode.AMEND
+    if check:
+        return Mode.CHECK
+    if init:
+        return Mode.INIT
+    if list_flag:
+        return Mode.LIST
+    if pr:
+        return Mode.PR
+    if squash:
+        return Mode.SQUASH
+    if stats:
+        return Mode.STATS
+    if update:
+        return Mode.UPDATE
+
+    return Mode.COMMIT
+
+
+def validate_options(
+    *,
+    mode: Mode,
+    stage_tracked: bool,
+    enable_debug: bool,
+    help_flag: bool,
+    version_flag: bool,
+    provider_override: str | None = None,
+    model_override: str | None = None,
+    time_flag: bool = False,
+    context: str | None = None,
+    files: list[str] | None = None,
+    print_only: bool = False,
+    crazy: bool = False,
+) -> None:
+    """
+    Validates the combination of command-line options provided by the user.
+    """
+    if enable_debug and (help_flag or version_flag):
+        typer.echo(
+            "Error: --debug cannot be used with --help or --version.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if stage_tracked and mode not in (Mode.COMMIT, Mode.AMEND):
+        typer.echo(
+            "Error: --all cannot be used with --init, --list, --update, --PR, or --squash.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if (provider_override or model_override) and mode in (
+        Mode.INIT,
+        Mode.LIST,
+        Mode.UPDATE,
+    ):
+        typer.echo(
+            "Error: --provider/--model cannot be used with --init, --list, or --update.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if time_flag and mode in (Mode.INIT, Mode.LIST, Mode.UPDATE):
+        typer.echo(
+            "Error: --time cannot be used with --init, --list, or --update.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if context and mode not in (Mode.COMMIT, Mode.AMEND, Mode.SQUASH, Mode.PR):
+        typer.echo(
+            "Error: --context cannot be used with --init, --list, or --update.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if files and mode not in (Mode.COMMIT, Mode.AMEND):
+        typer.echo(
+            "Error: --files cannot be used with --init, --list, --update, --PR, or --squash.",
+            err=True,
+        )
+        raise typer.Exit(code=1)
+
+    if print_only:
+        if mode not in (Mode.COMMIT, Mode.AMEND):
+            typer.echo(
+                "Error: --print can only be used in COMMIT or AMEND mode.",
+                err=True,
+            )
+            raise typer.Exit(code=1)
+        if crazy:
+            typer.echo(
+                "Error: --print and --crazy are mutually exclusive.",
+                err=True,
+            )
+            raise typer.Exit(code=1)