Agent CLI

Agent commands install project guidance files for coding assistants. They are intentionally separate from the MCP server: rules are persistent project instructions, while MCP provides live read-only context.

Use this after creating a workspace or when you want Cursor, Claude Code, Codex-style agents, and similar tools to follow Akan conventions consistently.

agent

Install Akan agent rules for editors and coding agents. The generated files summarize workspace shape, module abstract rules, generated file boundaries, validation commands, and the compact framework guideline.

Signature

Arguments

Argument	Type	Required	Default	Description
target	String	no	all	Rule target. Use cursor, agents-md, claude, or all.

target

Type

String

Required

Default

all

Description

Rule target. Use cursor, agents-md, claude, or all.

Options

Option	Type	Default	Enum / Flag	Description
--force	Boolean	false	-	Overwrite existing rule files. Without this flag, existing files are protected.

--force

Type

Boolean

Default

false

Enum / Flag

Description

Overwrite existing rule files. Without this flag, existing files are protected.

Notes

Name	Description
cursor	Writes `.cursor/rules/akan.mdc`.
agents-md	Writes `AGENTS.md` for generic agent clients such as Codex-style tools.
claude	Writes `CLAUDE.md` for Claude Code style project guidance.
abstract rule	Generated rules tell agents to read `*.abstract.md` before module behavior changes and update it when public behavior or workflows change.

cursor

Description

Writes `.cursor/rules/akan.mdc`.

agents-md

Description

Writes `AGENTS.md` for generic agent clients such as Codex-style tools.

claude

Description

Writes `CLAUDE.md` for Claude Code style project guidance.

abstract rule

Description

Generated rules tell agents to read `*.abstract.md` before module behavior changes and update it when public behavior or workflows change.

Examples

Agent CLI

agent

Commands