Guideline CLI

Guideline commands expose Akan's bundled agent instructions without invoking an LLM or changing files.

Use them when you want an external agent to load the most specific instruction for a module file, scalar file, UI pattern, or global framework rule.

guideline

List or show bundled Akan guideline instructions. Use these read-only commands when an agent, documentation tool, or contributor needs the same generation and review guidance used by Akan's internal instruction set.

Signature

Arguments

Argument	Type	Required	Default	Description
action	String	yes	-	Use list to print guideline names or show to print a specific instruction.
name	String	for show	-	Guideline name such as framework, moduleOverview, modelSignal, or scalarModule.

action

Type

String

Required

yes

Default

Description

Use list to print guideline names or show to print a specific instruction.

name

Type

String

Required

for show

Default

Description

Guideline name such as framework, moduleOverview, modelSignal, or scalarModule.

Options

Option	Type	Default	Enum / Flag	Description
--format	String	markdown	markdown \| json	Output format. JSON includes both instruction text and generation metadata for `show`.

--format

Type

String

Default

markdown

Enum / Flag

markdown | json

Description

Output format. JSON includes both instruction text and generation metadata for `show`.

Notes

Name	Description
read-only	`list` and `show` are public read-only commands. Instruction generation and reapply commands remain development-only.
agent context	MCP `get_guideline` and `akan guideline show` read from the same bundled guideline files.

read-only

Description

`list` and `show` are public read-only commands. Instruction generation and reapply commands remain development-only.

agent context

Description

MCP `get_guideline` and `akan guideline show` read from the same bundled guideline files.

Examples

Guideline CLI

guideline

Commands