사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
AkanJS 레퍼런스▾
가이드라인 CLI
가이드라인은 Akan CLI에 함께 들어 있는 코딩 에이전트용 지침 문서입니다.
akan guideline은 이 문서를 터미널에 출력할 뿐, LLM을 부르거나 파일을 바꾸지 않습니다.모듈 파일, 스칼라 파일, UI 패턴, 프레임워크 전반의 규칙 가운데 하나를 가장 구체적인 지침으로 확인하고 싶을 때 씁니다.
이 페이지에서 쓰는 말
용어설명
가이드라인
Akan CLI에 함께 들어 있는 코딩 에이전트용 지침 문서로, 영역이나 파일 역할마다 하나씩 있습니다.
AGENTS.md
에이전트가 작업마다 읽는 안내서로, 짧은 규칙만 담고 나머지는 가이드라인 이름으로 안내합니다.
MCP
코딩 에이전트가 바깥의 툴을 부르는 표준 방식인 Model Context Protocol입니다.
get_guideline
이름으로 가이드라인 하나를 돌려주는 MCP 툴입니다.
같은 내용을 읽는 경로
아래 경로는 모두 같은 파일을 읽습니다. 그래서 사람과 에이전트가 보는 내용이 같습니다.
경로설명
akan guideline show <name>
사람이 터미널에서 가이드라인 하나를 Markdown으로 읽습니다.
get_guideline
akan code 에이전트와 akan mcp에 연결한 에디터 에이전트가 가이드라인 하나를 받는 툴입니다.akan://guidelines/<name>
MCP 클라이언트의 리소스 목록에 가이드라인마다 리소스가 하나씩 있습니다.
akan agent install
framework, conventions, workspaceOnboarding을 에이전트가 읽는 AGENTS.md에 복사해 둡니다.- AGENTS.md는 복사본입니다.
akan agent install을 실행한 시점에 쓰이고, 나머지 경로는 매번 설치된 CLI에서 읽습니다. - 에이전트는 깊이 손대기 전에 불러옵니다.
AGENTS.md가 영역마다 가이드라인 이름을 알려 주고, 에이전트는 그 영역을 크게 바꾸기 전에get_guideline으로 불러옵니다.
guideline
CLI에 들어 있는 가이드라인 목록을 보여 주거나, 그중 하나를 Markdown으로 출력합니다.
에이전트, 문서 도구, 기여자가 한 영역에 대해
AGENTS.md보다 깊은 내용이 필요할 때 씁니다.형식
인자
actionString필수list | show
list는 가이드라인 이름을 한 줄에 하나씩 모두 출력하고, show는 가이드라인 하나를 출력합니다.nameString
show로 출력할 가이드라인 이름으로, framework, moduleOverview, modelSignal 등이 있고 show에는 꼭 필요합니다.참고
이름설명
읽기 전용
가이드라인은 CLI와 함께 설치되는 파일이며, 이 명령은 읽기만 하고 쓰지 않습니다.
에이전트와 같은 내용
MCP
get_guideline과 akan guideline show는 같은 가이드라인 파일을 읽습니다.없는 이름
show에 없는 이름을 주면, 쓸 수 있는 이름을 모두 나열한 오류로 끝납니다.버전
내용은 설치된 CLI에 들어 있는 그대로라서, CLI를 업그레이드하면 함께 바뀝니다.
예시
가이드라인 목록
akan guideline list가 출력하는 이름을 다루는 범위별로 묶었습니다. 목록은 설치된 CLI를 따르므로, 이 페이지보다 명령의 출력이 정확합니다.워크스페이스 전체
가이드라인설명
framework
apps·libs·pkgs가 맡는 일과 모듈의 레이어 순서만 담은 가장 짧은 개요입니다.
conventions
akan agent install이 AGENTS.md에 써 넣는 컨벤션 전체입니다.workspaceOnboarding
워크스페이스 구조, 에이전트 작업 흐름, 자주 쓰는 명령, 코드 종류별 위치를 담습니다.
workspaceRecipes
자주 하는 변경의 단계별 예시와, 레이어마다 자동으로 생기는 API 목록입니다.
moduleOverview
데이터베이스 모듈에서 어느 파일이 무엇을 맡는지와, 모듈을 키워 가는 순서입니다.
영역별 심화 규칙
그 영역을 크게 바꾸기 전에 해당 가이드라인을 읽습니다.
가이드라인설명
ssrRule
.tsx 파일에 "use client"가 필요한 경우와, 마크업을 서버에 두는 방법입니다.runtimeRule
SSR·CSR 제공 범위, API 경로 prefix, 프로세스 구성, 로깅, Docker 이미지, 함께 배포되는 에셋입니다.
queryRule
필터, 슬라이스와 하이드레이션, 전문 검색, 연쇄 삭제(cascade)입니다.
transportRule
HTTP·웹소켓 공통 가드, 소켓 식별과 정리, 바이너리 pubsub, mutation의 HTTP 메서드입니다.
mcpRule
MCP로 에이전트에게 보이는 엔드포인트,
option.setMcp 설정, OAuth 로그인, 페이지 프롬프트입니다.agentRule
페이지 안 에이전트의
<Agent.Chat />, st.tool, 폼, 에이전트가 읽을 수 있는 범위를 다룹니다.fieldRule
모델 상수와 스칼라 상수 파일에서 쓰는
field() 헬퍼와 그 옵션입니다.cssRule
시맨틱 색상 토큰,
styles.css의 테마 선언, 라이브러리 전용 tokens.css입니다.componentRule
공통 UI 규칙과,
_overrides.tsx로 akanjs/ui 컴포넌트를 바꿔 끼우는 방법입니다.recipeRule
같은 룩을 한 곳에만 두도록 Tailwind variant 레시피를 쓰고 만드는 규칙입니다.
모듈 파일별
데이터베이스 모듈과 스칼라의 파일 역할마다 가이드라인이 하나씩 있습니다.
가이드라인설명
modelConstant
<model>.constant.tsInput부터 전체 모델까지, 모든 레이어가 함께 쓰는 데이터 형태입니다.
modelDictionary
<model>.dictionary.ts필드, enum, 쿼리, 슬라이스, 엔드포인트, 오류의 라벨과 문구입니다.
modelDocument
<model>.document.ts필터, 문서 체인 메서드, 컬렉션 헬퍼, 인덱스입니다.
modelService
<model>.service.ts무엇을 불러와 어떤 메서드를 엮고 언제 저장할지 정하는 비즈니스 흐름입니다.
modelSignal
<model>.signal.ts내부 작업, 슬라이스, 엔드포인트와 그 가드로 이루어진, 호출할 수 있는 API입니다.
modelStore
<model>.store.ts폼·목록·상세의 클라이언트 상태와, UI가 부르는 액션입니다.
modelTemplate
<Model>.Template.tsx스토어의 폼 상태와 setter에 연결된 폼 조각입니다.
modelUnit
<Model>.Unit.tsx카드, 행, 배지처럼 라이트 모델을 작게 보여 주는 표시 요소입니다.
modelView
<Model>.View.tsx상세 페이지와 보기 모달에 쓰는 전체 상세 화면입니다.
modelUtil
<Model>.Util.tsx액션 버튼, 툴바, 대화상자처럼 모델 전용으로 쓰는 작은 컨트롤입니다.
modelZone
<Model>.Zone.tsx로더, 목록, 뷰, 템플릿을 묶어 만드는 페이지 구획입니다.
scalarModule
lib/__scalar/<scalar>/값을 모듈이 아닌 스칼라로 둘 때와, 스칼라 폴더에 들어가는 파일입니다.
scalarConstant
<scalar>.constant.ts부모 모델 없이도 뜻이 통하는 작은 내장 값 객체입니다.
scalarDictionary
<scalar>.dictionary.ts스칼라 필드와 enum 값의 라벨과 설명입니다.