image
Akan.js
Docs
문서컨벤션레퍼런스Cheatsheet
한국어
image
Akan.js
Akan.js v2 문서가 새로 나왔습니다.v1 문서 보기
문서컨벤션레퍼런스Cheatsheet
MIT 라이선스 하에 배포되었습니다.
Akan.js 공식 컨설팅 서비스Akansoft
Copyright © 2026 Akan.js 모든 권리 보유.
시스템 관리자bassman
CLI 레퍼런스
• 명령어
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
• Context
• Agent
• Guideline
AkanJS 레퍼런스
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI 레퍼런스
• Overview
• Core
• Display
• Forms
• Overlays
• System
CLI 레퍼런스
• 명령어
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
• Context
• Agent
• Guideline
AkanJS 레퍼런스
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI 레퍼런스
• Overview
• Core
• Display
• Forms
• Overlays
• System
이전
Cloud
다음
Agent

Context CLI

Context command는 사람, agent, CI job, MCP client가 읽을 수 있는 형태로 Akan workspace 구조를 제공합니다.
`context`는 workspace 이해에, `doctor`는 convention 검증에, `mcp`는 MCP client가 같은 정보를 stdio로 조회해야 할 때 사용합니다.

context

Print agent-readable Akan workspace context. Use it when an external coding agent, CI job, or IDE extension needs a structured summary of apps, libraries, packages, modules, generated files, validation commands, and module abstracts.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--formatStringmarkdownmarkdown | jsonOutput format. Use json for tools and markdown for people or chat context.
--appString-nullableLimit the context to one app.
--moduleString-nullableLimit module output and include the matching *.abstract.md content first.
--format
Type
String
Default
markdown
Enum / Flag
markdown | json
Description
Output format. Use json for tools and markdown for people or chat context.
--app
Type
String
Default
-
Enum / Flag
nullable
Description
Limit the context to one app.
--module
Type
String
Default
-
Enum / Flag
nullable
Description
Limit module output and include the matching *.abstract.md content first.
Notes
NameDescription
abstract exposureWorkspace summaries include abstract metadata only; module-scoped context includes the abstract body.
privacyThe context analyzer does not print .env values or secrets.
abstract exposure
Description
Workspace summaries include abstract metadata only; module-scoped context includes the abstract body.
privacy
Description
The context analyzer does not print .env values or secrets.
Examples

doctor

Report Akan workspace convention diagnostics. Use it before or after agent changes to catch unsupported files, missing module abstracts, and convention drift in machine-readable form.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--formatStringtexttext | jsonOutput format. Use json for agent validation loops.
--strictBooleanfalse-Treat recommended conventions such as missing module abstracts as errors.
--format
Type
String
Default
text
Enum / Flag
text | json
Description
Output format. Use json for agent validation loops.
--strict
Type
Boolean
Default
false
Enum / Flag
-
Description
Treat recommended conventions such as missing module abstracts as errors.
Examples

mcp

Start the read-only Akan MCP server over stdio. The server exposes workspace context, module context, guideline instructions, command explanations, diagnostics, and resources for MCP-aware coding agents.
Signature
Notes
NameDescription
modeRead-only. It does not write files, scaffold modules, or call LLM providers.
module context`get_module_context` returns the module abstract first, then surrounding module file metadata.
mode
Description
Read-only. It does not write files, scaffold modules, or call LLM providers.
module context
Description
`get_module_context` returns the module abstract first, then surrounding module file metadata.
Examples
Context CLI
context
doctor
mcp