aquin.help_display_ascii Namespace Reference

Functions
dict	help_payload (*, bool connected, SessionMode|None mode, bool show_llm, str|None model_id=None, bool show_embed=False)
None	render_help_quiet (*, bool connected, SessionMode|None mode, bool show_llm, str|None model_id=None, bool show_embed=False)
list[str]	_cmd_row (str cmd, str desc, int w)
None	_section_rows (str title, list[tuple[str, str]] rows, *, str|None footnote=None, int w)
None	render_help (*, bool connected, SessionMode|None mode, bool show_llm, str|None model_id=None, bool show_embed=False)

Variables
	SessionMode = Literal["llm"]

Function Documentation

_cmd_row()

list[str] _cmd_row ( str cmd, str desc, int w )

protected

Definition at line 211 of file help_display_ascii.py.

Referenced by _section_rows().

_section_rows()

None _section_rows ( str title, list[tuple[str, str]] rows, * , str | None footnote = None, int w )

protected

Definition at line 218 of file help_display_ascii.py.

References _cmd_row().

Referenced by render_help().

help_payload()

dict help_payload	(	*	,
		bool	connected,
		SessionMode | None	mode,
		bool	show_llm,
		str | None	model_id = None,
		bool	show_embed = False )

Structured help for `--json` / quiet CLI surfaces.

Definition at line 25 of file help_display_ascii.py.

Referenced by render_help_quiet().

render_help()

None render_help	(	*	,
		bool	connected,
		SessionMode | None	mode,
		bool	show_llm,
		str | None	model_id = None,
		bool	show_embed = False )

Definition at line 235 of file help_display_ascii.py.

References _section_rows().

render_help_quiet()

None render_help_quiet	(	*	,
		bool	connected,
		SessionMode | None	mode,
		bool	show_llm,
		str | None	model_id = None,
		bool	show_embed = False )

Section title + real bordered command tables.

Definition at line 170 of file help_display_ascii.py.

References help_payload().

Variable Documentation

SessionMode

aquin.help_display_ascii.SessionMode = Literal["llm"]

Definition at line 23 of file help_display_ascii.py.