ChatStyle Docs

ChatStyle is a reusable CLI interaction style and runtime package for Click CLIs that need consistent prompts, missing-argument recovery, -i/-I, TTY handling, secret masking, and flow-stage display.

Core Modules

• chatstyle.input: input schemas, resolver, and Click integration.
• chatstyle.tui: prompt and choice primitives.
• chatstyle.render: output and flow display.
• chatstyle.security: secret masking and sensitive input.
• chatstyle.core: TTY, interactive policy, constants, and errors.
• chatstyle.patterns: cross-module recipes.

Navigation

• Modules: module responsibilities and boundaries.
• Interaction Conventions: -i/-I, missing arguments, prompts, secrets, and automation compatibility.
• Development Guide: API, dependency, testing, docs, and workflow rules.
• Interaction Runtime: runtime boundaries and downstream usage.
• 简体中文: Chinese entrypoint.

CommandSchema

CommandSchema is a core ChatStyle feature. It declares CLI fields and centralizes defaults, missing-argument prompting, validation, and interactive policy.

from chatstyle import CommandField, CommandSchema

SCHEMA = CommandSchema(
    name="demo",
    fields=(
        CommandField("name", prompt="name", required=True),
        CommandField("path", prompt="output path", kind="path", default="./out.txt"),
    ),
)

Local Preview

pip install -e ".[docs]"
mkdocs serve