에이전트 CLI
akan agent install은 코딩 에이전트가 코드를 고치기 전에 읽는 규칙 파일을 씁니다. 모든 에이전트가 읽는 AGENTS.md 하나와, Claude Code·Cursor용 포인터 파일입니다. 규칙은 한 번만 쓰고 모든 에이전트가 같은 사본을 읽습니다.이 페이지에서 쓰는 말
용어설명
에이전트 가이드
워크스페이스의
AGENTS.md입니다. 모든 코딩 에이전트가 따르는 규칙을 이 파일 하나에 담습니다.포인터
도구 하나에게
AGENTS.md를 읽으라고만 알려 주는 짧은 파일입니다. CLAUDE.md가 그 예입니다.관리 블록
AGENTS.md에서 akan:agent 마커 사이 부분입니다. 명령은 이 부분만 다시 씁니다.앱·라이브러리 가이드
apps/<app>/AGENTS.md, libs/<lib>/AGENTS.md입니다. 그 앱이나 라이브러리가 import할 수 있는 UI 레시피를 적습니다.대상별로 쓰는 파일
대상을 하나 고르거나, 생략해서 셋 다 씁니다. 가이드는 블록만 새로 쓰고, 포인터는 파일을 통째로 씁니다.
대상
AGENTS.md
앱·라이브러리
가이드
가이드
CLAUDE.md
Cursor
가이드 · 블록만 다시 쓰므로
--force가 필요 없음agents-md
✓
✓
관리 블록을 다시 만들고, 앱·라이브러리 가이드도 모두 씁니다.
포인터 · 파일을 통째로 쓰므로 이미 있으면
--force 필요claude
✓
Claude Code가
@AGENTS.md로 가이드를 불러옵니다.cursor
✓
가이드를 가리키는, 항상 적용되는 Cursor 규칙입니다.
기본값
all
✓
✓
✓
✓
셋 모두를
cursor, agents-md, claude 순서로 씁니다.✓씀안 씀
--force는 CLAUDE.md와 Cursor 규칙을 통째로 덮어씁니다. 거기에 직접 적은 내용은 사라지므로, 직접 쓰는 지침은 AGENTS.md의 akan:agent 마커 바깥에 두세요.언제 실행하나요
- 새 워크스페이스에는 이미 있습니다.
create-workspace가akan agent install all --force를 실행합니다.--agent-install false를 주면 건너뜁니다. - Akan 버전을 올린 뒤.
bun update는 가이드를 그대로 두므로akan agent install agents-md를 실행합니다. 대상 없이akan agent install만 실행하면 이미 있는 Cursor 규칙에서 멈추고 아무것도 쓰지 않습니다. akan doctor가 경고할 때.agent-guide-stale은 지금 설치된 것과 다른 릴리스가 가이드를 썼다는 뜻이고,agent-guide-unstamped는 버전 표시가 없다는 뜻입니다. 둘 다akan agent install agents-md로 고칩니다.- 포인터를 하나만 추가할 때. 대상으로
claude나cursor만 지정합니다.AGENTS.md를 스스로 읽는 Codex 같은 에이전트는 포인터가 필요 없습니다.
가이드에 담기는 내용
관리 블록은 설치된 Akan 릴리스와 지금 워크스페이스를 바탕으로 새로 만들어집니다. 위에서부터 이런 내용이 들어갑니다.
섹션설명
워크스페이스
저장소 이름과 그 안의 앱, 라이브러리, 패키지 목록입니다.
컨벤션
코딩 규칙입니다. 빌드를 깨뜨리는 린트 규칙도 여기에 있습니다.
온보딩
워크스페이스 구조, 자주 쓰는 명령, 코드 종류별로 둘 곳, 자주 틀리는 부분입니다.
샘플 정리
create-workspace가 만든 샘플이 남아 있을 때만 들어가며, 지울 샘플을 알려 줍니다.모듈 abstract
모듈의
*.abstract.md를 먼저 읽고, 모듈 동작이 바뀌면 갱신하라는 규칙입니다.생성 파일
직접 고치면 안 되는 생성 파일과, 그 파일을 다시 만드는 명령입니다.
레시피
akanjs/ui 레시피 목록입니다. 앱·라이브러리 레시피는 각자의 가이드에 있습니다.MCP 워크플로 정책
직접 고치기보다 Akan 워크플로를 먼저 쓰라는 규칙입니다. MCP나 CLI로 실행합니다.
검증 명령
작업을 확인할
sync, lint, typecheck, test, build, doctor, quality 명령입니다.프레임워크 가이드
코드 종류별로 둘 곳, 모듈 흐름, 테마와 UI를 바꾸는 방법입니다.
마무리 점검
작업을 넘기기 전 점검 목록입니다. 린트, 타입 검사, sync, SSR 비율, 주석, abstract를 확인합니다.
규칙과 MCP
규칙과 MCP 서버는 일부러 나눠 두었습니다.
create-workspace는 둘 다 설치합니다.규칙 파일
에이전트가 모든 세션에 늘 지니고 가는 지침입니다. 이 저장소에서 코드를 쓰는 방법을 알려 줍니다.
akan agent installMCP 서버
그때그때 질문에 답하고, apply 모드에서는 규칙이 가리키는 워크플로까지 실행합니다.
akan mcp-install관련 페이지
agent
에이전트 가이드와 포인터 파일을 워크스페이스에 씁니다.
Akan 버전을 올린 뒤 다시 실행하세요.
AGENTS.md는 관리 블록만 다시 쓰므로 직접 쓴 내용은 그대로 남습니다.형식
인자
actionString필수
항상
install입니다. 생략하면 CLI가 입력을 묻고, 다른 값을 주면 오류를 내고 멈춥니다.targetString기본값 allcursor | agents-md | claude | all
쓸 파일을 고릅니다. 생략하면 셋 다 씁니다.
옵션
--forceBoolean기본값 false-f
이미 있는
CLAUDE.md나 .cursor/rules/akan.mdc를 덮어씁니다. AGENTS.md에는 필요 없습니다.참고
이름설명
agents-md
AGENTS.md를 쓰고, 이어서 각 apps/<app>/AGENTS.md와 libs/<lib>/AGENTS.md를 씁니다.cursor
AGENTS.md를 가리키는 alwaysApply 규칙 .cursor/rules/akan.mdc를 씁니다.claude
CLAUDE.md를 씁니다. @AGENTS.md import 한 줄과, 한 번 더 적은 주석 규칙이 들어갑니다.기존 AGENTS.md
마커 사이 블록만 바꿉니다. 마커가 없는 파일이면 블록을 끝에 덧붙입니다.
기존 포인터
--force가 없으면 그 파일에서 오류를 내고 멈추며, 뒤에 남은 파일은 쓰지 않습니다.앱·라이브러리 가이드
akan sync <name>이 최신으로 유지하고, 오래된 가이드가 있으면 akan lint가 실패합니다.건너뛴 앱·라이브러리
설정을 아직 불러올 수 없는 앱·라이브러리는 건너뜁니다. 나중에
akan sync <name>이 씁니다.앱·라이브러리 CLAUDE.md
앱과 라이브러리마다
CLAUDE.md 포인터도 만듭니다. 이미 있으면 건드리지 않습니다.최신 여부
bun update는 블록을 다시 쓰지 않습니다. akan agent install agents-md로 새로 고칩니다.버전 표시
블록에는 그것을 쓴 릴리스가 적히고,
akan doctor가 지금 설치된 버전과 비교합니다.플래그 위치
--force는 맨 뒤에 씁니다. --force claude는 claude를 플래그 값으로 읽어, --force 없이 셋 다 씁니다.예시