사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
AkanJS 레퍼런스▾
CLI 명령
akan CLI는 워크스페이스의 처음부터 끝까지를 맡습니다. 워크스페이스와 앱 생성, 코드 생성, 로컬 개발, 네이티브 빌드, 로컬 데이터베이스, 선택 기능인 클라우드 도구까지 다룹니다.이 페이지는 색인입니다. 그룹마다 인자 표, 옵션 표, 주의 사항, 터미널 예시가 담긴 상세 페이지로 연결됩니다.
명령 표기 읽는 법
표기설명
<app>
명령에 필요한 값입니다. 생략하면 명령이 물어봅니다.
[filename]
선택 값입니다. 없어도 명령이 실행됩니다.
<app|lib|pkg>
|는 '또는'입니다. 앱, 라이브러리, 패키지 중 하나의 이름을 씁니다.<sys:module>
앱이나 라이브러리 이름과 모듈 이름을 콜론으로 잇습니다. 예:
myapp:icecreamOrder.[apps...]
앱 이름 하나 이상입니다. 공백이나 쉼표로 구분하고,
all은 모든 앱입니다.--name <value>
옵션입니다. 단어는
-로 잇습니다. 예: --max-diagnostics 0.--fix false
불리언 옵션은
true나 false를 받습니다. 값 없이 쓰면 true입니다.--no-write
기본값이
true인 불리언 옵션은 --no-<name>으로도 끌 수 있습니다.공통 동작
아래 내용은 모든 명령에 똑같이 적용되므로, 상세 페이지에서는 반복하지 않습니다.
자세한 출력
-v, --verbose모든 명령이 받는 옵션입니다. 평소 스피너 뒤에 가려지는 프로세스 출력을 그대로 보여 줍니다.
도움말
akan <command> --help명령의 인자와 옵션을 기본값, 선택지와 함께 출력합니다.
akan만 입력하면 전체 명령 목록이 나옵니다.워크스페이스 루트에서 실행
package.json · tsconfig.json · .envcreate-workspace를 뺀 모든 명령은 이 세 파일이 있는 폴더에서 실행합니다. 다른 곳에서 실행하면 오류를 내고 멈춥니다.짧은 별칭
akan ba = akan build-android명령 아홉 개는
-로 나뉜 단어의 첫 글자만으로도 실행됩니다. 아래 표에 모두 있습니다.| 별칭 | 실행되는 명령 |
|---|---|
| akan s | akan start |
| akan b | akan build |
| akan t | akan typecheck |
| akan bi | akan build-ios |
| akan ba | akan build-android |
| akan bd | akan build-desktop |
| akan si | akan start-ios |
| akan sa | akan start-android |
| akan sd | akan start-desktop |
값을 생략했을 때
생략한 값은 기본값으로 채우거나, 명령이 직접 물어봅니다.
| 생략한 값 |
|---|
| ↳ CLI의 동작 |
| 기본값이 있는 값 |
기본값을 씁니다. akan quality는 quality scan으로 실행됩니다. |
| 선택 값 |
| 비워 둔 채로 실행합니다. |
<app> |
| 목록에서 고릅니다. 워크스페이스에 앱이 하나뿐이면 묻지 않고 그 앱을 씁니다. |
<lib> <pkg> <app|lib> <sys:module> |
| 목록에서 고릅니다. 모듈은 앱이나 라이브러리를 먼저 고른 다음 모듈을 고릅니다. |
akan start의 [apps...] |
| 지난번 선택이 체크된 체크리스트가 열립니다. 앱이 하나뿐이면 건너뜁니다. |
| 그 밖의 값 |
| 프롬프트가 물어봅니다. 직접 입력하거나, 선택지에서 고르거나, 예/아니오로 답합니다. |
검증 순서
변경을 마쳤다고 하기 전에 아래 다섯 가지를 순서대로 실행합니다. 워크스페이스의 에이전트 가이드인
AGENTS.md가 정한 순서입니다.akan sync <app|lib>의존성, 설정, 생성 파일을 최신으로 맞춥니다. 파일을 추가하거나 이름을 바꾸거나 지운 뒤에 꼭 필요합니다.akan lint <app|lib|pkg>Biome으로 포맷과 린트를 합니다. Akan 컨벤션 규칙도 함께 검사합니다.akan typecheck <app>앱 전체의 TypeScript 타입을 검사합니다.akan test <app|lib|pkg>테스트를 실행합니다.akan build <app>프로덕션 결과물을 빌드합니다.
보고만 하는 명령
아래 세 명령은 보고서만 출력하므로 실행을 실패시키지 않습니다. 리뷰 전에 읽어 두세요.
명령설명
doctor --strict --format json
워크스페이스가 Akan 컨벤션에서 벗어난 곳을 보여 줍니다.
--strict는 권장 사항도 오류로 셉니다.quality scan
모든 앱과 라이브러리의 코드 형태 경고를 보여 줍니다.
quality ssr
앱과 라이브러리마다 server render share를 출력합니다. 50%가 하한선이고, 비율이 떨어지면 회귀입니다.
명령 색인
아래 이름은 모두
akan 뒤에 붙여 씁니다. 예: akan lint myapp. 그룹 제목을 누르면 인자, 옵션, 예시가 있는 상세 페이지로 갑니다.내부용 명령과 개발 전용 명령은 일부러 뺐습니다.
워크스페이스를 만들고, 안의 모든 것을 한 번에 린트·동기화합니다.
명령설명
새 워크스페이스를 만듭니다.
--app <app>으로 첫 앱의 이름을 정합니다.앱, 라이브러리, 패키지 하나를 Biome으로 린트하고 고칠 수 있는 것은 고칩니다. 앱과 라이브러리는 먼저 동기화합니다.
모든 앱과 라이브러리를 동기화한 다음, 모든 앱·라이브러리·패키지를 린트합니다.
모든 라이브러리를 동기화한 다음, 모든 앱을 동기화합니다.
앱을 만들고 지우고, 로컬에서 띄우고, 실행 중인 서버를 들여다봅니다.
명령설명
apps/ 아래에 새 앱을 만듭니다.워크스페이스에서 앱을 지웁니다.
앱이나 라이브러리 하나의 의존성, 설정, 생성 파일을 최신으로 맞춥니다.
앱 하나 이상의 개발 서버를 띄웁니다. 별칭은
s입니다.apps/<app>/script/<filename>.ts를 실행합니다. 파일을 생략하면 어느 것인지 묻습니다.대화형 서버 콘솔을 엽니다.
실행 중인 앱의 로그를 레벨, 엔드포인트, trace 등으로 걸러 가며 봅니다.
앱의 데이터를 한 데이터베이스 모드에서 꺼내 다른 모드로 옮깁니다.
앱을 독립된 워크스페이스로 옮길 때 필요한 파일을 정확히 나열합니다.
변경을 내보내기 전에 타입 검사, 테스트, 빌드를 합니다.
명령설명
앱의 타입을 검사합니다. 별칭은
t입니다.앱, 라이브러리, 패키지의 테스트를 준비하고 실행합니다.
프런트엔드와 백엔드를 함께 프로덕션용으로 빌드합니다. 별칭은
b입니다.네이티브 런타임으로 iOS, Android, 데스크톱 앱을 빌드하고, 실행하고, 출시합니다.
명령설명
네이티브 런타임으로 iOS, Android, 데스크톱 앱을 빌드합니다. 별칭은
bi, ba, bd입니다.시뮬레이터, 에뮬레이터, 실기기에서 앱을 실행합니다. 별칭은
si, sa입니다.이 컴퓨터(macOS, Windows, Linux)에서 앱을 데스크톱 앱으로 실행합니다. 별칭은
sd입니다.App Store나 Play Store에 낼 릴리스를 빌드하고 패키징합니다.
업데이트 키를 만들고, 설치된 앱이 받을 릴리스를 서명해 게시하거나, 폰 업데이트를 서명 없이 묶습니다.
앱이 쓰는 공유 라이브러리를 만들고, 설치하고, 지우고, 동기화합니다.
명령설명
libs/ 아래에 새 공유 라이브러리를 만듭니다.워크스페이스에서 라이브러리를 지웁니다.
라이브러리 하나의 의존성과 설정을 동기화합니다.
shared, util 같은 미리 만들어 둔 라이브러리를 설치합니다.각 라이브러리가 설치해 온 원본과 아직 같은지 보고합니다.
데이터베이스 모듈과 서비스 모듈, 그리고 모듈에 붙는 선택 UI 파일을 생성합니다.
명령설명
데이터베이스 모듈을 만듭니다. constant, service, signal, store, UI 파일이 생깁니다.
lib/_<service>에 서비스 모듈을 만듭니다. 데이터베이스 파일은 없습니다.앱이나 라이브러리에서 모듈을 지웁니다.
View를 추가합니다. 레코드 하나의 상세 화면입니다.
Unit을 추가합니다. 목록의 행이나 카드 하나입니다.
Template을 추가합니다. 모듈의 폼입니다.
다른 모델 안에 들어가는 값 타입을 만듭니다. 자체 데이터베이스 테이블은 없습니다.
명령설명
lib/__scalar/<scalarName>에 스칼라를 만듭니다.앱이나 라이브러리에서 스칼라를 지웁니다.
pkgs/ 아래의 패키지를 만들고, 빌드하고, 검증합니다.명령설명
워크스페이스가 쓰는
akanjs 버전을 출력합니다.pkgs/<name>에 새 패키지를 만듭니다.워크스페이스에서 패키지를 지웁니다.
패키지 하나의 의존성과 설정을 동기화합니다.
배포용으로 패키지를 빌드합니다.
빌드된 패키지를
npm pack dry run으로 확인합니다.이미 있는 모듈을 위한 CRUD route를 앱 안에 생성합니다.
명령설명
모듈의 목록, 상세, 생성, 수정 페이지를 만듭니다.
이미 있는 모듈에 조각 하나를 더합니다. UI 파일, 필드, enum 필드 중 하나입니다.
명령설명
View, Unit, Template 중 하나를 추가합니다.
--surface로 고르며 기본값은 template입니다.모듈의 constant와 dictionary에 필드 하나를 추가합니다.
쉼표로 구분한 값 목록으로 enum 필드 하나를 추가합니다.
변경을 계획하고, 계획을 읽고, 적용하고, 결과를 검증하고, 검증이 잡은 문제를 고칩니다.
명령설명
쓸 수 있는 워크플로를 나열합니다.
워크플로 하나를 설명합니다.
변경을 계획하고 계획 JSON을
--out에 씁니다. 소스는 건드리지 않습니다.계획을 적용합니다.
--dry-run은 파일을 쓰지 않고 예상 보고서만 보여 줍니다.실행이 바꾼 내용을 검증합니다.
실행의 보고서를 출력합니다.
좁은 범위의 복구 하나를 실행합니다.
generated, format, imports, dictionary, module-shape 중 하나입니다.모든 앱과 라이브러리의 코드 품질 경고를 보고하고, 각각의 server render share를 잽니다.
명령설명
모든 앱과 라이브러리의 코드 품질 경고를 보고합니다.
akan quality만 써도 이것이 실행됩니다.앱과 라이브러리마다 server render share와 SSR 경고를 출력합니다.
같은 보고서를 도구용 JSON으로 출력합니다.
선택 기능입니다. Akan Cloud 로그인, 환경 변수 전송, 프레임워크 업데이트를 맡습니다.
명령설명
Akan.js를 최신 버전으로 업데이트합니다.
클라우드나 SCP 서버에서 환경 변수를 내려받거나 올립니다.
로컬에서 실행 중인 앱을 공개 URL로 공유합니다. 개발 세션과 별개인 독립 명령입니다.
명령설명
실행 중인 앱을 공개 URL로 공유합니다.
--ttl로 만료까지의 시간(분)을 정합니다.이 계정이 열어 둔 공유를 나열합니다.
해당 코드의 공유를 멈춥니다.
코딩 에이전트에게 워크스페이스 컨텍스트, 컨벤션 진단, Akan MCP 툴을 건넵니다.
명령설명
에이전트용 워크스페이스 컨텍스트를 출력합니다.
--module을 주면 그 모듈의 abstract도 넣습니다.워크스페이스가 Akan 컨벤션에서 벗어난 곳을 보고합니다.
Akan MCP 서버를 stdio로 띄웁니다. 범위는
--mode로 readonly(기본값), plan, apply 중에서 정합니다.mcp-install [target]
Cursor, Claude Code, Codex 설정에 Akan MCP 서버 항목을 씁니다. 생략하면 셋 모두 씁니다.
에디터와 코딩 에이전트가 읽는 규칙 파일을 설치합니다.
명령설명
cursor, agents-md, claude 규칙을 씁니다. 생략하면 셋 모두 씁니다.워크스페이스의 툴과 스킬을 갖춘 Akan 코딩 에이전트를 터미널에서 실행합니다.
명령설명
프롬프트 하나로 에이전트를 실행합니다. 프롬프트가 없으면 전체 화면 세션을 엽니다.
프로필을
local(기본값), pod, review, web 중에서 고릅니다.저장된 세션을 id로 이어 갑니다.
코딩 에이전트가 읽는 Akan 가이드라인을 출력합니다.
명령설명
모든 가이드라인 이름을 나열합니다.
이름으로 가이드라인 하나를 출력합니다. 예시는
framework입니다.