클라우드 명령
Akan Cloud 로그인, 프레임워크 업데이트, env 값 옮기기에 쓰는 명령 다섯 가지로, 필요할 때만 씁니다. 내부 배포용 명령은 일부러 이 페이지에서 뺐습니다.
이 페이지에서 쓰는 말
용어설명
Akan Cloud
https://cloud.akanjs.com에서 계정, env 값, 터널을 관리하는 서비스입니다.env 값
앱과 라이브러리마다 있는
env/env.client.<env>.ts, env/env.server.<env>.ts 파일로, git에 올리지 않습니다.AKAN_WORKSPACE_ID
루트
.env에 적는 클라우드 워크스페이스 id로, env 값을 보관할 곳을 정합니다.SCP 서버
클라우드 워크스페이스가 없을 때 env 값을 보관하는 자체 서버로, SSH로 접속합니다.
명령마다 접속하는 곳
명령
Akan Cloud
SCP
npm
이 컴퓨터만
계정
login
✓
브라우저로 로그인하고 세션을 저장합니다.
logout
✓
클라우드에 연락하지 않고 저장된 세션만 지웁니다.
프레임워크
update
✓
npm에서 설치하고,
--registry local이면 로컬 레지스트리에서 설치합니다.env 값
download-env
✓
✓
워크스페이스가 쓰는 쪽(Akan Cloud 또는 SCP 서버)에서 env 값을 내려받습니다.
upload-env
✓
✓
로컬 env 값을 같은 곳에 올려, 다음
download-env가 받게 합니다.✓접속함접속 안 함
- 워크스페이스 루트에서 실행합니다. 대부분의
akan명령처럼package.json,tsconfig.json,.env가 있는 폴더에서 실행해야 합니다. --host로 다른 클라우드를 가리킵니다. Akan Cloud와 통신하는 명령은 모두 이 옵션을 받으므로, 직접 운영하는 클라우드도 같은 명령으로 씁니다.- 로그인은 컴퓨터마다, 호스트마다 하나입니다. 세션은
~/.akan/config.json에 저장되므로 이 컴퓨터의 모든 워크스페이스가 함께 씁니다.
env 값을 보관하는 곳
download-env와 upload-env는 루트 .env를 읽어 보관 위치를 정합니다. 둘은 같은 곳을 쓰므로, 올린 것을 그대로 내려받습니다.| 보관처 | 쓰는 경우 |
|---|---|
| ↳ 압축본이 있는 곳 | |
| Akan Cloud | AKAN_WORKSPACE_ID가 있을 때 |
| 그 id의 클라우드 워크스페이스이며, 필요하면 먼저 로그인합니다. | |
| SCP 서버 | AKAN_WORKSPACE_ID가 비어 있을 때 |
목록에서 고른 서버의 ~/secrets/<repo>/env.tar입니다. | |
양쪽 모두 덮어씁니다.
upload-env는 보관된 압축본을 통째로 바꾸고, download-env는 같은 경로의 로컬 파일을 덮어씁니다. 고치기 전에 내려받고, 고친 뒤 바로 올립니다.관련 페이지
login
이 컴퓨터에서 Akan Cloud에 로그인합니다.
CLI가 브라우저에 로그인 페이지를 열고, 그곳에서 로그인을 마칠 때까지 기다립니다.
형식
옵션
--hostString기본값 https://cloud.akanjs.com
사용할 Akan Cloud 주소로, 프레임워크 저장소(
USE_AKANJS_PKGS=true)에서는 http://localhost:8283입니다.참고
이름설명
브라우저
로그인 URL과 QR 코드를 출력하고 브라우저로 열며, 브라우저가 열리지 않으면 URL에 직접 접속합니다.
제한 시간
10분 안에 로그인하지 않으면 멈추므로, 다시 실행합니다.
이미 로그인됨
계정 닉네임을 출력하고, 브라우저를 열지 않은 채 끝납니다.
만료 임박 세션
만료가 가깝거나 지났으면 먼저 갱신하고, 갱신에 실패할 때만 브라우저를 엽니다.
저장 위치
~/.akan/config.json에 호스트마다 세션 하나를 저장하며, 본인만 읽을 수 있습니다.쓰는 명령
akan tunnel과 akan start --share에 필요하며, env 명령은 필요하면 스스로 로그인합니다.예시
logout
이 컴퓨터의 Akan Cloud 로그인을 해제합니다.
계정을 바꾸거나, 이 컴퓨터의 클라우드 접근을 없앨 때 씁니다.
형식
옵션
--hostString기본값 https://cloud.akanjs.com
사용할 Akan Cloud 주소로, 프레임워크 저장소(
USE_AKANJS_PKGS=true)에서는 http://localhost:8283입니다.참고
이름설명
지우는 것
그
--host에 저장된 세션만 지우고, 다른 호스트의 세션은 그대로 둡니다.로그인 안 됨
세션이 없다고 알리고 아무것도 바꾸지 않습니다.
예시
update
전역
akan CLI와 이 워크스페이스의 Akan.js 패키지를 릴리스 태그의 최신 버전으로 올립니다.
보통은 latest를 쓰고, beta, rc, canary는 그 채널을 일부러 시험할 때만 씁니다.형식
옵션
--tagString기본값 latestlatest | dev | canary | beta | rc | alpha
설치할 릴리스 채널입니다.
--registryString기본값 npmnpm | local
local은 AKAN_NPM_REGISTRY이고, 비어 있으면 http://127.0.0.1:4873입니다.참고
이름설명
package.json
워크스페이스 안이면 루트
package.json의 akanjs와 @akanjs/devkit을 그 버전으로 바꾸고 bun install을 실행합니다.전역 설치
@akanjs/cli@<tag>를 bun add -g로 전역 설치하고, 끝에 akan --version을 출력합니다.--registry local
npm에 배포하기 전의 프레임워크 빌드를 로컬 레지스트리에서 받아 시험합니다.
프레임워크 저장소
USE_AKANJS_PKGS=true이면 --registry에 기본값이 없어 CLI가 물어봅니다.예시
download-env
이 워크스페이스의 모든 앱과 라이브러리의 env 값을 내려받습니다.
env 값은 커밋되지 않으므로, clone한 직후와 누군가 변경을 올렸을 때마다 실행합니다.
형식
옵션
--hostString기본값 https://cloud.akanjs.com
AKAN_WORKSPACE_ID가 있을 때 쓸 Akan Cloud 주소로, SCP 서버를 쓸 때는 무시합니다.참고
이름설명
보관 위치
루트
.env에 AKAN_WORKSPACE_ID가 있으면 Akan Cloud, 없으면 SCP 서버입니다.파일
upload-env가 묶은 경로 그대로 워크스페이스 루트에 풀어 덮어씁니다.첫 SCP 실행
서버 이름과 호스트, 그리고 비워 둘 수 있는 사용자 이름과 SSH 포트를 묻습니다.
서버 목록
~/.akan/config.json에 저장되어, 다음부터는 서버를 고르거나 추가하거나 지웁니다.예시
upload-env
모든 앱과 라이브러리의 env 값을
download-env가 읽는 곳으로 올립니다.
보관된 압축본은 통째로 바뀌므로, 오래된 로컬 사본을 올리지 말고 먼저 내려받습니다.형식
옵션
--hostString기본값 https://cloud.akanjs.com
AKAN_WORKSPACE_ID가 있을 때 쓸 Akan Cloud 주소로, SCP 서버를 쓸 때는 무시합니다.참고
이름설명
보관 위치
루트
.env에 AKAN_WORKSPACE_ID가 있으면 Akan Cloud, 없으면 SCP 서버입니다.env 파일
env/env.client.<env>.ts와 env/env.server.<env>.ts이며, type, example 파일은 빠집니다.secrets
앱의
akan.config.ts에 적은 secrets glob에 맞는 파일도 함께 올립니다..gitignore
올릴 때마다 그
secrets 패턴을 .gitignore 안에서 akan이 관리하는 구역에 적습니다.파일 없음
올릴 env 파일이 하나도 없으면 오류로 멈춥니다.
예시