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커스터마이즈
    다음명령어

    터널 CLI

    akan tunnel은 노트북에서 돌고 있는 개발 서버에 필요한 동안만 공개 URL을 붙여 줍니다. 배포할 필요가 없습니다.
    휴대폰으로 바로 확인
    디자이너가 방금 만든 화면을 지금 자기 휴대폰으로 열어 봅니다.
    외부 webhook 받기
    결제사 webhook이 아직 고치고 있는 핸들러까지 곧바로 도착합니다.
    대개는 앱을 띄우는 김에 공유도 필요하므로 akan start --share로 세션과 함께 엽니다. akan tunnel은 따로 쓰는 형태로, 이미 실행 중인 앱을 공유하는 일만 합니다. 어느 쪽을 쓸지는 아래에 정리했습니다.
    이 페이지에서 쓰는 말
    용어설명
    공유
    로컬 앱 하나를 공개 URL에 연결한 것입니다. 코드, URL, 만료 시각을 가집니다.
    코드
    공유마다 붙는 짧은 이름입니다. --stop에 넘깁니다.
    Akan Cloud
    공개 주소를 발급하고 공유 목록을 관리하는 서버입니다. akan login으로 로그인하는 곳입니다.
    TTL
    공유가 저절로 만료되기까지의 시간입니다.

    tunnel

    이 컴퓨터에서 실행 중인 앱을 공개 URL로 공유합니다. 연결은 이 명령 프로세스 안에서 돌기 때문에, URL을 받기 전에 따로 설치할 프로그램이 없습니다. 명령이 떠 있는 동안만 공유가 유지되고, Ctrl-C로 끝내면 주소를 반납합니다.
    형식
    인자
    appString
    공유할 앱입니다. 앱이 하나뿐이면 그 앱을 쓰고, 여럿이면 목록에서 고릅니다.
    옵션
    --listBoolean기본값 false
    이 계정의 공유를 연결 상태, 코드, URL, 앱 이름, 만료 시각과 함께 보여 주고 끝냅니다.
    --stopString기본값 ""
    이 코드의 공유를 회수하고 끝냅니다.

    --share와 tunnel 중 고르기

    둘 다 같은 Akan Cloud에 같은 종류의 공유를 엽니다. 다른 점은 공유를 어느 프로세스가 쥐고 있느냐, 그래서 언제 끝나느냐입니다.
    항목akan start --shareakan tunnel
    공유 대상세션이 띄우는 모든 앱이미 실행 중인 앱 하나
    끝나는 때개발 세션이 끝날 때명령을 멈출 때
    포트앱의 개발 포트개발 포트, 또는 --port로 준 포트
    만료Akan Cloud 기본값--ttl에 준 시간(분), 또는 Akan Cloud 기본값
    Akan Cloud기본 주소

    이 페이지

    터널 CLI
    tunnel
    --share와 tunnel 중 고르기
    URL을 아는 사람은 누구나 개발 서버 전체에 접근할 수 있습니다. page/ 아래 모든 라우트, API 경로, 웹소켓, 앱이 마운트했다면 /mcp까지 아무 보호 없이 열립니다. --ttl을 주고, 통화가 끝나면 바로 멈추고, 운영 데이터에 로그인된 세션은 절대 공유하지 마세요.
    --hostString기본값 https://cloud.akanjs.com
    사용할 Akan Cloud 주소입니다. 프레임워크 저장소(USE_AKANJS_PKGS=true)에서는 http://localhost:8283입니다.
    --portNumbernullable
    공유할 로컬 포트입니다. 비우면 akan start가 이 앱에 쓰는 개발 포트입니다.
    --ttlNumbernullable
    공유가 저절로 만료되기까지의 시간(분)입니다. 비우면 Akan Cloud가 정합니다.
    참고
    이름설명
    URL
    만료 시각, akan tunnel --stop <code> 안내와 함께 출력되고 클립보드에 복사됩니다.
    Ctrl-C
    처음 누르면 주소를 반납합니다. 한 번 더 누르면 반납 없이 바로 끝나고, 공유는 TTL이 지나면 만료됩니다.
    재연결
    연결이 끊기면 알린 뒤 다시 연결합니다. 공유는 끝나지 않습니다.
    앱보다 먼저
    앱이 뜨기 전에 공유를 열어도 됩니다. 포트가 열릴 때까지는 요청이 거절됩니다.
    계정
    공유는 그 --host에 akan login으로 로그인한 계정의 것입니다. --list도 그 계정의 공유를 보여 줍니다.
    --list · --stop
    둘 다 앱을 묻지 않습니다. 계정의 공유를 다룹니다.
    배포가 아님
    요청은 개발 서버로 그대로 전달됩니다. 앞에 인증, 캐시, 빌드 단계가 붙지 않습니다.
    예시
    기본 주소, 또는 --host로 준 주소
    URL 확인전체 화면 뷰 헤더에 나오고 s로 복사하며, --plain이면 출력됩니다출력되고 클립보드에 복사됩니다
    공유에 실패하면오류를 출력하고 세션은 그대로 띄웁니다오류와 함께 명령이 끝납니다
    • 전체 화면 뷰의 s 키. 선택한 앱의 공개 URL을 복사합니다. all apps 행에서는 모든 앱의 URL을 복사합니다.
    • 헤더. 뷰는 공개 URL을 로컬 URL보다 앞에 보여 줍니다.
    • akan tunnel이 맞는 경우. --share 없이 띄운 앱이나 개발 포트가 아닌 포트를 두 번째 터미널에서 공유할 때 씁니다. 멈춰도 개발 서버는 그대로입니다.
    akan start→
    전체 화면 뷰, --kill, --concurrency 같은 개발 세션 자체의 옵션입니다.
    akan login→
    Akan Cloud에 로그인합니다. 공유는 이 계정에 속합니다.