:py:mod:`gmuse.cli.main` ======================== .. py:module:: gmuse.cli.main .. autodoc2-docstring:: gmuse.cli.main :allowtitles: Module Contents --------------- Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`version_callback ` - .. autodoc2-docstring:: gmuse.cli.main.version_callback :summary: * - :py:obj:`main ` - .. autodoc2-docstring:: gmuse.cli.main.main :summary: * - :py:obj:`info ` - .. autodoc2-docstring:: gmuse.cli.main.info :summary: * - :py:obj:`msg ` - .. autodoc2-docstring:: gmuse.cli.main.msg :summary: * - :py:obj:`_load_config ` - .. autodoc2-docstring:: gmuse.cli.main._load_config :summary: * - :py:obj:`_copy_to_clipboard ` - .. autodoc2-docstring:: gmuse.cli.main._copy_to_clipboard :summary: * - :py:obj:`_error_exit ` - .. autodoc2-docstring:: gmuse.cli.main._error_exit :summary: * - :py:obj:`_format_dry_run_output ` - .. autodoc2-docstring:: gmuse.cli.main._format_dry_run_output :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`logger ` - .. autodoc2-docstring:: gmuse.cli.main.logger :summary: * - :py:obj:`app ` - .. autodoc2-docstring:: gmuse.cli.main.app :summary: API ~~~ .. py:data:: logger :canonical: gmuse.cli.main.logger :value: 'get_logger(...)' .. autodoc2-docstring:: gmuse.cli.main.logger .. py:data:: app :canonical: gmuse.cli.main.app :value: 'Typer(...)' .. autodoc2-docstring:: gmuse.cli.main.app .. py:function:: version_callback(value: bool) -> None :canonical: gmuse.cli.main.version_callback .. autodoc2-docstring:: gmuse.cli.main.version_callback .. py:function:: main(version: bool = typer.Option(None, '--version', help='Show the version and exit.', is_eager=True, callback=version_callback)) -> None :canonical: gmuse.cli.main.main .. autodoc2-docstring:: gmuse.cli.main.main .. py:function:: info() -> None :canonical: gmuse.cli.main.info .. autodoc2-docstring:: gmuse.cli.main.info .. py:function:: msg(hint: typing.Optional[str] = typer.Option(None, '--hint', help="Additional guidance for message generation (e.g., 'emphasize security')"), copy: bool = typer.Option(False, '--copy', '-c', help='Copy generated message to clipboard'), model: typing.Optional[str] = typer.Option(None, '--model', '-m', help="LLM model to use (e.g., 'gpt-4', 'claude-3-opus')"), format: typing.Optional[str] = typer.Option(None, '--format', '-f', help="Message format: 'freeform' (default), 'conventional', or 'gitmoji'"), history_depth: typing.Optional[int] = typer.Option(None, '--history-depth', help='Number of recent commits to use for style context (0-50)'), temperature: typing.Optional[float] = typer.Option(None, '--temperature', help='LLM sampling temperature (0.0-2.0, default: 0.7)'), max_tokens: typing.Optional[int] = typer.Option(None, '--max-tokens', help='Maximum tokens in LLM response (default: 500)'), max_diff_bytes: typing.Optional[int] = typer.Option(None, '--max-diff-bytes', help='Maximum diff size in bytes before truncation (default: 20000)'), include_branch: bool = typer.Option(False, '--include-branch', help='Include current branch name as context for commit message generation'), dry_run: bool = typer.Option(False, '--dry-run', help='Print the assembled prompt without calling the LLM provider')) -> None :canonical: gmuse.cli.main.msg .. autodoc2-docstring:: gmuse.cli.main.msg .. py:function:: _load_config(model: typing.Optional[str] = None, copy: bool = False, format: typing.Optional[str] = None, history_depth: typing.Optional[int] = None, temperature: typing.Optional[float] = None, max_tokens: typing.Optional[int] = None, max_diff_bytes: typing.Optional[int] = None, include_branch: bool = False) -> gmuse.config.ConfigDict :canonical: gmuse.cli.main._load_config .. autodoc2-docstring:: gmuse.cli.main._load_config .. py:function:: _copy_to_clipboard(message: str) -> None :canonical: gmuse.cli.main._copy_to_clipboard .. autodoc2-docstring:: gmuse.cli.main._copy_to_clipboard .. py:function:: _error_exit(message: str, code: int = 1, hint: typing.Optional[str] = None) -> None :canonical: gmuse.cli.main._error_exit .. autodoc2-docstring:: gmuse.cli.main._error_exit .. py:function:: _format_dry_run_output(model: typing.Optional[str], format: str, truncated: bool, system_prompt: str, user_prompt: str) -> str :canonical: gmuse.cli.main._format_dry_run_output .. autodoc2-docstring:: gmuse.cli.main._format_dry_run_output