CLI contract APIs

These modules define result envelopes and command metadata used by automation and generated documentation. The command catalog, not raw Typer implementation details, is the source of truth for the generated reference.

.. py:module:: memoryledger.command_results

Typed result dataclasses for major commands.

Use these instead of constructing unrelated dictionaries in command handlers.

.. py:class:: StatusResult(initialized, configured, layout=’’, config_path=None, storage_path=None, memory_count=0, candidate_count=0, accepted_count=0, rejected_count=0, archived_count=0, next_action=None)

module:

memoryledger.command_results

Bases: :py:class:object

Result for the status command.

type initialized:

sphinx_autodoc_typehints_type:

\:py\:class\:\bool``

param initialized:

type configured:

:sphinx_autodoc_typehints_type:\:py\:class\:\bool``

param configured:

type layout:

:sphinx_autodoc_typehints_type:\:py\:class\:\str``

param layout:

type config_path:

:sphinx_autodoc_typehints_type:\:py\:class\:\str` | :py:obj:`None``

param config_path:

type storage_path:

:sphinx_autodoc_typehints_type:\:py\:class\:\str` | :py:obj:`None``

param storage_path:

The CLI contract emits ledgerwerk.cli.v1; callers should use its schema and exit codes rather than human output.