kapi voice guide

$ kapi guide [path]

Print the voice guide in force.

Inside a project, a path selects the voice for that file's own content. An item that declares a file for its comments alone governs only those comments, so the content resolves to the next item that claims the file, or to the project's default point. --comments asks for the point the file's comments sit at instead, and lists the comment limits in force there. Ask with --comments before writing a comment, in a Go source file or any other.

Commandvoice guide

Try it

Runs in your browser against a small sample file. Edit the command before running, or press Run to execute it as shown.

$ kapi voice guide

Flags

Flag	Type	Default	Description
--channel	string		apply channel-specific overrides
--color	string	auto	colorize output: auto, always, never
--comments	bool	false	resolve the voice at the point the file's comments sit at
--file	string		explicit path to resource file
--jq	string		filter JSON output through a jq expression (implies --json)
--json	bool	false	Output in JSON format
--local	bool	false	use resource in current directory
--locale	string		apply locale-specific overrides
--name	string		named resource in KAPI_HOME (e.g. --name project-terms)
--output-format	string		Output format: text (alias: table), json, yaml
--pack	string		built-in starter pack name
--persona	string		apply an author persona's overrides (within the profile guardrails)
--profile	string		voice profile name in the local store
--profile-file	string		path to a standalone profile YAML
--project , -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--text	bool	false	Output in text format (default)

← Back to the Command Reference