Agent CLI

Agent command는 coding assistant를 위한 project guidance file을 설치합니다. rule은 지속되는 project instruction이고 MCP는 live read-only context를 제공하므로 둘은 의도적으로 분리되어 있습니다.

workspace 생성 후 또는 Cursor, Claude Code, Codex 스타일 agent 등이 Akan convention을 일관되게 따르도록 만들고 싶을 때 사용합니다.

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

명령어