사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
AkanJS 레퍼런스▾
워크스페이스 CLI
워크스페이스 전체를 다루는 명령입니다. 새 워크스페이스를 만들고, 모든 앱과 라이브러리를 한 번에 린트·sync합니다.
명령설명
첫 앱, 에이전트 규칙, MCP 설정까지 갖춘 새 워크스페이스를 만듭니다.
앱, 라이브러리, 패키지 하나를 Biome으로 포맷하고 린트합니다.
모든 앱과 라이브러리를 sync한 뒤, 모든 앱·라이브러리·패키지를 린트합니다.
모든 라이브러리에
akan sync를 실행한 뒤 모든 앱에 실행합니다.이 페이지에서 쓰는 말
용어설명
워크스페이스 루트
저장소의 최상위 폴더입니다.
package.json, tsconfig.json, .env가 있는 곳입니다.sync
앱이나 라이브러리를 다시 스캔해 생성 파일을 새로 씁니다. 하나만 할 때는
akan sync <app|lib>입니다.Biome
Akan이 쓰는 포매터이자 린터입니다. 규칙은 워크스페이스 루트의
biome.json에 있습니다.어떤 명령을 쓸까
관리용 명령 세 개는 다루는 범위와, sync 뒤에 린트까지 하는지가 다릅니다.
명령
sync
lint
대상 하나
lint
✓
✓
앱, 라이브러리, 패키지 하나를 고쳤을 때 씁니다. 패키지는 sync 없이 린트만 합니다.
워크스페이스 전체
lint-all
✓
✓
생성 파일, 앱 코드, 라이브러리를 함께 맞춰 봐야 하는 넓은 검증 전에 씁니다.
sync-all
✓
생성 파일이 오래돼 보이거나 워크스페이스 공통 설정을 바꿨을 때 씁니다.
✓실행함실행 안 함
create-workspace
새 워크스페이스와 첫 앱을 한 번에 만듭니다. 아래 순서로 진행합니다.
<dir>/<workspaceName>에 워크스페이스 파일을 씁니다.--registry값은.npmrc에 들어갑니다.bun install을 실행합니다.--init false면 건너뜁니다.--libs true일 때만util과shared라이브러리를 설치합니다.--app으로 정한 이름의 첫 앱을 만듭니다.- 에이전트 규칙과 MCP 설정을 씁니다.
--agent-install과--mcp-install로 끌 수 있습니다. - 첫 git 커밋을 남깁니다. git이 실패해도 워크스페이스는 그대로 쓸 수 있으니 직접 커밋합니다.
cd <dir>/<workspaceName> && akan start <app>.형식
인자
workspaceNameString필수
조직 또는 워크스페이스 이름입니다. 소문자로 바뀌고 공백은 하이픈이 됩니다. 생략하면 물어봅니다.
옵션
--appString필수
첫 앱의 이름입니다. 소문자로 바뀌고 공백은 하이픈이 됩니다. 생략하면 물어봅니다.
--dirString기본값 .
워크스페이스를 담을 상위 폴더로, 실행 위치 기준입니다.
USE_AKANJS_PKGS=true면 local입니다.--libsBoolean기본값 false
shared와 util도 설치합니다. 권장대로 끄면 빈 워크스페이스에서 시작합니다.--initBoolean기본값 true
파일을 만든 뒤
bun install을 실행합니다.--registryString기본값 https://registry.npmjs.org
Akan 패키지를 받을 npm 레지스트리로,
.npmrc에 저장됩니다. AKAN_NPM_REGISTRY가 기본값을 정합니다.--ownerString기본값 $GITHUB_OWNER
저장소의 GitHub 소유자입니다. 값이 있으면
README.md에 GitHub Codespaces 배지가 붙습니다.--mcp-installBoolean기본값 true
Cursor, Claude Code, Codex의 프로젝트 설정 파일에 Akan MCP 서버를 등록합니다.
--agent-installBoolean기본값 true-A
코딩 에이전트용
AGENTS.md, CLAUDE.md, .cursor/rules/akan.mdc를 씁니다.참고
이름설명
실행 위치
워크스페이스 루트를 새로 만드는 명령이라 어느 폴더에서나 실행합니다.
MCP 설정 파일
Cursor는
.cursor/mcp.json, Claude Code는 .mcp.json, Codex는 .codex/config.toml을 읽습니다.프레임워크 버전
--tag 옵션은 없습니다. 다른 릴리스 채널로 옮기려면 akan update --tag <tag>를 씁니다.create-akan-workspace
bunx create-akan-workspace는 버전이 같은 @akanjs/cli를 전역 설치한 뒤 이 명령을 실행합니다.예시
lint
앱, 라이브러리, 패키지 하나를 Biome으로 포맷하고 린트합니다. 고친 내용은 기본으로 파일에 쓰고, 앱과 라이브러리는 먼저 sync합니다. Biome 다음에는 아래 참고의 세 가지를 검사합니다.
형식
인자
app|lib|pkgString필수
앱, 라이브러리, 패키지 이름입니다. 생략하면 목록에서 고릅니다.
옵션
--fixBoolean기본값 true
포매터와 린트가 고친 내용을 파일에 씁니다.
--fix false면 보고만 합니다.--max-diagnosticsNumber기본값 200
Biome이 잘라 내기 전까지 출력하는 진단 수입니다.
0이면 제한이 없습니다.참고
이름설명
테마 대비
page/styles.css의 색 조합이 WCAG 대비 기준에 못 미치면 실패합니다.레시피
ui/Recipe의 레시피에 고를 variant나 플래그가 없으면 실패합니다.에이전트 색인
앱이나 라이브러리
AGENTS.md의 레시피 색인이 오래되면 실패합니다. akan sync로 고칩니다.예시
lint-all
모든 앱과 라이브러리를 sync한 뒤, 모든 앱·라이브러리·패키지를 린트합니다. 검사 항목은
lint와 같습니다. 생성 파일, 앱 코드, 공유 라이브러리를 함께 맞춰 봐야 하는 넓은 검증 전에 실행합니다.형식
옵션
--fixBoolean기본값 true
포매터와 린트가 고친 내용을 파일에 씁니다.
--fix false면 보고만 합니다.--max-diagnosticsNumber기본값 200
Biome이 잘라 내기 전까지 출력하는 진단 수입니다.
0이면 제한이 없습니다.예시
sync-all
모든 라이브러리에
akan sync를 실행한 뒤 모든 앱에 실행합니다. 생성 파일이 오래돼 보이거나 워크스페이스 공통 설정을 바꾼 뒤에 씁니다.형식
예시
모든 명령의 공통 규칙
- 워크스페이스 루트에서 실행합니다.
create-workspace를 뺀 모든 명령은package.json,tsconfig.json,.env가 있는 폴더에서 실행합니다. - 불리언 옵션.
--fix처럼 이름만 쓰면 true입니다. 끄려면 값을 붙입니다:--fix false. - 짧은 플래그. 옵션은 첫 글자로도 씁니다(
--fix는-f).-A처럼 다른 글자를 쓰는 옵션은 표에 따로 적혀 있습니다. - 자세한 출력.
-v를 붙이면 평소 스피너 뒤에 가려지는 프로세스 출력을 그대로 보여 줍니다.
관련 페이지