Akan.js
Docs
문서컨벤션레퍼런스Cheatsheet
Akan.js
문서컨벤션레퍼런스Cheatsheet
Akan.js

MIT 라이선스 하에 배포되었습니다.

Akan.js 공식 컨설팅 서비스AkansoftCopyright © 2026 Akan.js 모든 권리 보유.시스템 관리자bassman
사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
명령어WorkspaceApplicationLibraryModuleScalarPackagePagePrimitiveWorkflowQualityContextAgentGuideline
AkanJS 레퍼런스▾
akanjs/baseakanjs/commonakanjs/constantakanjs/fetchakanjs/signalakanjs/serverakanjs/clientakanjs/webkit
UI 레퍼런스▾
OverviewCoreDisplayFormsOverlaysSystemAgent커스터마이즈
사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
명령어WorkspaceApplicationLibraryModuleScalarPackagePagePrimitiveWorkflowQualityContextAgentGuideline
AkanJS 레퍼런스▾
akanjs/baseakanjs/commonakanjs/constantakanjs/fetchakanjs/signalakanjs/serverakanjs/clientakanjs/webkit
UI 레퍼런스▾
OverviewCoreDisplayFormsOverlaysSystemAgent커스터마이즈
다음명령어

Code CLI

akan code는 이 워크스페이스를 이미 아는 AI 코딩 에이전트를 터미널에서 실행합니다. 에디터를 열거나 MCP 클라이언트를 설정하거나 모듈 규칙을 설명할 필요 없이, 필드를 추가하고 검증 루프까지 돌려 달라고 바로 맡기면 됩니다.
  1. 워크스페이스 .env에 모델 키를 넣습니다. 기본 모델이라면 DEEPSEEK_API_KEY입니다.
  2. akan code로 세션을 열거나, akan code "<prompt>"로 한 번만 실행합니다.
에이전트가 처음부터 갖춘 것
기본 코딩 툴
read · write · edit · ls · grep · find · bash
파일을 읽고 고치고 명령을 실행하며, 웹 페이지를 가져오거나 웹을 검색합니다. 어느 것이 켜지는지는 프로필이 정합니다.
Akan 툴
plan_workflow · apply_workflow · run_validation
컨텍스트 조회, 워크플로, 복구, 검증 툴입니다. akan mcp가 에디터의 에이전트에게 주는 것과 같은 묶음입니다.
Akan 스킬
akan-module · akan-store · akan-validate · …
스캐폴딩 순서, 스토어 사용법, 검증 루프를 담은 안내서로, 작업에 필요할 때 읽습니다. 직접 쓴 스킬은 ~/.akan/code/skills나 .akan/code/skills에 둡니다.
프로젝트 규칙
AGENTS.md
워크스페이스의 AGENTS.md가 컨텍스트에 실려 있어, 첫 턴부터 이 저장소의 규칙을 따릅니다.
akan mcp, akan agent install과의 차이
명령어에이전트 위치
↳ 설명
akan code터미널
위의 툴과 규칙을 이미 갖춘 독립 에이전트입니다.
akan mcp에디터
에디터의 에이전트가 이 워크스페이스의 툴을 쓰게 해 주는 서버입니다.
akan agent install에디터
에디터의 에이전트가 읽는 규칙 파일을 씁니다.
세 가지 실행 방식
명령어는 하나지만 실행 방식은 셋이고, 서브커맨드 없이 인자로 정해집니다. 위에서부터 차례로 확인합니다:
실행 방식조건
↳ 결과
RPC--rpc
다른 프로세스가 에이전트를 구동하도록 stdio로 akan wire frame을 주고받습니다.
전체 화면 세션--interactive이거나, 터미널에서 프롬프트와 --json을 모두 생략했을 때
계속 대화를 이어 가는 채팅 화면입니다. 넘긴 프롬프트는 첫 메시지가 됩니다.
한 번 실행그 밖에 프롬프트가 있을 때
프롬프트를 끝까지 실행하며 이벤트를 출력합니다. --json이면 이벤트마다 JSON 한 줄입니다.
  • 터미널이 없거나 --json을 줬을 때 프롬프트가 없으면 오류입니다. 파이프나 CI 단계에서는 항상 프롬프트를 넘깁니다: akan code "add a comment module".
  • 스크립트에는 한 번 실행이 맞습니다. 프롬프트가 끝나면 종료되고, --json을 주면 기계가 읽기 좋은 출력이 됩니다.

code

Akan 코딩 에이전트를 실행합니다. 프롬프트를 주면 한 번 실행하고, 생략하면 전체 화면 세션을 엽니다.
형식
인자
promptString
에이전트에게 맡길 일입니다. 터미널에서 생략하면 전체 화면 세션이 열립니다.
옵션
--appStringnullable · flag: -a
에이전트의 범위를 apps/<app> 하나로 좁힙니다. 생략하면 저장소 전체가 대상입니다.
--profileString기본값 locallocal | pod | review | web · flag: -p
에이전트가 할 수 있는 일(툴, 승인, 세션 저장)을 고릅니다. 아래 프로필 표를 보세요.
--modelStringnullable · flag: -m
<provider>/<id> 형식입니다. 기본은 deepseek/deepseek-flash이고, 그 키가 없으면 쓸 수 있는 첫 모델입니다.
--jsonBoolean기본값 falseflag: -j
이벤트를 한 줄에 하나씩 JSON으로 출력합니다. 이때 전체 화면 세션은 --interactive를 줄 때만 열립니다.
--thinkingBoolean기본값 falseflag: -t
모델의 추론 과정을 출력과 함께 보여 줍니다.
--rpcBoolean기본값 falseflag: -r
다른 프로세스가 쓰도록 에이전트를 stdio의 akan wire frame으로 제공합니다. 다른 모든 실행 방식보다 우선합니다.
--resumeStringnullable · flag: -R
저장된 세션을 id로 찾아 전체 화면 세션에서 이어 갑니다. 세션을 저장하는 프로필은 local과 web뿐입니다.
--interactiveBoolean기본값 falseflag: -i
프롬프트를 줬어도 전체 화면 세션을 열고, 그 프롬프트를 첫 메시지로 보냅니다.
참고
이름설명
API 키
워크스페이스 .env나 셸 환경에 <PROVIDER>_API_KEY를 둡니다. 예: DEEPSEEK_API_KEY.
세션 id
대화가 있던 전체 화면 세션은 닫힐 때 akan code --resume <id> 줄을 출력합니다.
세션 파일
워크스페이스의 .akan/code/sessions에 저장됩니다. 없는 id를 주면 오류가 납니다.
차단 경로
어떤 프로필이든 허용 목록과 상관없이 .env, .env.*, secrets/, *.pem, *.key를 거부합니다.
예시

프로필

프로필은 에이전트가 할 수 있는 일을 값 하나로 묶은 것이고, --profile로 고릅니다. 어떤 툴이 있는지, 쓰기 전에 승인을 받는지, 세션을 어디에 두는지, 프로젝트 문맥을 얼마나 싣는지가 여기서 정해집니다.
프로필
쓰기·실행
웹
MCP
쓰기 승인
세션 저장
질문·승인에 답이 올 때까지 기다림 (await)
local
✓
✓
✓
✓
기본값입니다. 모든 기능이 켜져 있고 승인을 묻지 않습니다.
review
리뷰어용입니다. read, ls, grep, find만 쓰고 AGENTS.md는 싣지 않으며, 세션은 메모리에만 둡니다.
질문·승인에서 턴을 끝내고 나중에 이어 감 (suspend)
pod
✓
✓
지켜보는 사람이 없는 격리 컨테이너입니다. MCP만 빼고 모두 켜집니다.
web
✓
✓
✓
✓
✓
범위는 local과 같지만, 파일을 쓸 때마다 승인을 받습니다.
✓켜짐꺼짐
  • await와 suspend. await는 답이 올 때까지 턴을 열어 둡니다. suspend는 턴을 끝냈다가 답을 담아 새 턴을 열므로, 프로세스가 재시작돼도 이어집니다.
  • Akan 툴과 스킬은 모든 프로필에 있습니다. 단, review는 아무것도 바꾸지 않는 Akan 툴만 받습니다.
  • web이 승인을 묻는 것은 write와 edit뿐입니다. bash는 승인을 묻지 않고 실행됩니다.
  • MCP 서버는 두 파일에서 읽습니다. ~/.akan/code/mcp.json은 내 설정, .akan/code/mcp.json은 이 저장소의 설정이고, 이름이 겹치면 워크스페이스 쪽이 이깁니다.
  • --app은 실제 경계입니다. 프로필의 루트를 apps/<app>으로 옮기고, 파일 툴은 그 밖의 경로를 거부합니다. 그 앱에만 머물러 달라고 프롬프트로 부탁하는 것보다 확실합니다.
차단 목록은 bash의 샌드박스가 아닙니다. .env를 이름으로 적은 명령은 거부되지만, 셸은 여전히 어떤 경로에든 닿을 수 있습니다. 진짜 경계는 pod 프로필이 도는 컨테이너입니다.
함께 볼 문서
아키텍처 · Agentic→
터미널이 아니라 렌더링된 페이지 안에서 도는 에이전트입니다.
Agent CLI→
에디터의 에이전트가 읽는 규칙 파일을 쓰는 akan agent install입니다.
akan mcp→
이 워크스페이스의 툴을 에디터의 에이전트에게 넘겨주는 MCP 서버입니다.

이 페이지

Code CLI
code
프로필