개발자 문서

CLI

명령 레퍼런스

aimz 의 모든 명령입니다. aimz <명령> --help 로 터미널에서도 볼 수 있습니다.

공통 옵션

모든 명령 뒤에 붙일 수 있습니다.

옵션설명
--server URL서버 주소. 기본 https://aimzlabs.com (환경 변수 AIMZ_SERVER)
--json사람이 읽는 출력 대신 JSON — 스크립트·에이전트용
--help명령 도움말
예
aimz models -m video --json
aimz whoami --server https://aimzlabs.com

계정

login

브라우저로 로그인합니다. --no-browser 는 주소를 출력하고 화면의 코드를 붙여 넣는 방식(SSH 등). 기본 대기 300초.

사용법
aimz login [--no-browser] [--timeout 초]

logout

이 PC 의 토큰과 크레딧 사용 동의 기록을 지웁니다.

사용법
aimz logout

whoami

계정·크레딧 잔액·에이전트 확인 모드.

사용법
aimz whoami

update

새 판이 있는지 지금 확인하고, 이 PC 의 설치 방식(pipx·venv)에 맞는 업데이트 명령을 알려 줍니다. 평소에도 명령을 쓸 때 하루 한 번 확인해 새 판이 있으면 알려 줍니다(끄기: AIMZ_NO_UPDATE_CHECK=1).

사용법
aimz update [--json]

모델·견적

models

생성 모델 목록과 기본 1회 크레딧. ★ 는 추천 모델.

사용법
aimz models [-m image|video|audio|text] [-q 검색어]

model

모델의 입력 키 규격(타입·선택지·범위·기본값).

사용법
aimz model <model_id>

voices

ElevenLabs 목소리. --library 면 공개 라이브러리에서 찾습니다. id 는 -p voice=<id> 로 씁니다.

사용법
aimz voices [-q 검색어] [--library [--language ko] [--gender male|female] [--age …] [--use-case …] [--sort …] [--page N]]

voice

ElevenLabs 목소리 링크나 ID 로 그 목소리를 찾습니다.

사용법
aimz voice <링크|ID>

estimate

예상 크레딧. 입력 옵션은 generate 와 같습니다.

사용법
aimz estimate <model_id> [--prompt …] [-p 키=값 …]

생성·작업

generate

생성합니다(크레딧 사용). 끝날 때까지 기다리고 결과 URL·파일을 출력합니다. --project 를 주면 결과가 스튜디오의 그 프로젝트에 담깁니다(없으면 만듭니다).

사용법
aimz generate <model_id> --prompt … [-p 키=값 …] [--image 경로|URL] [--ref 경로|URL …] [-o 폴더] [--project 이름]

jobs

job_id 없이: 진행 중인 작업 목록. 있으면 그 작업 상태, --wait 로 끝날 때까지 대기.

사용법
aimz jobs [job_id] [--wait] [--timeout 초] [-o 폴더]

batch

JSON 배열 [{model_id, params}, …] 을 한 번 승인으로 접수. 서버 대기열이 순서대로 돌린다. --project 를 주면 전부 그 프로젝트에 담깁니다.

사용법
aimz batch <파일.json> [--wait] [-o 폴더] [--session 이름] [--project 이름] [-y]

wait

여러 작업을 함께 기다린다. 실패가 있으면 종료 코드 1.

사용법
aimz wait <job_id …> [--any] [--timeout 초] [-o 폴더]

queue

생성 대기열 — 실행 칸·대기 수·새 작업 예상 시작·내 작업 순번.

사용법
aimz queue

failures

최근 실패한 생성과 이유.

사용법
aimz failures [--limit 20]

라이브러리·파일

library

가져온 원본을 포함한 내 라이브러리. --id로 원본 한 항목의 주소·정보를 확인합니다.

사용법
aimz library [-m 종류] [-q 검색어] [--limit 20] [--offset 0] [--folder inbox|폴더id] [--no-uploads]
aimz library --id ID [--output-index 0]

projects

스튜디오 프로젝트 목록. --add 는 그 이름의 프로젝트를 찾거나 만들고, 준 생성물(library 의 id)을 그 안에 담습니다.

사용법
aimz projects [-q 검색어] | aimz projects --add <이름> [생성물번호 …]

upload

파일을 라이브러리에 등록하고 URL·generation_id를 받습니다(50MB까지). --temporary는 임시 입력 URL만 만듭니다.

사용법
aimz upload <파일> [--request-id ID] [--temporary]

download

URL 을 파일로 저장합니다. 같은 이름은 번호를 붙여 덮어쓰지 않습니다.

사용법
aimz download <URL …> [-o 폴더]

workflows

Labs 워크플로우 목록, wf_id 를 주면 그래프.

사용법
aimz workflows [wf_id]

space

워크스페이스. flows 는 예시 워크플로우(숏드라마·시트콤·제품 광고 등), new 는 그 흐름으로 새 워크스페이스, plan 은 만들 순서와 예상 크레딧, run 은 기획부터 완성본까지 순서대로 만듭니다(크레딧 사용). 끊기면 --request-id 로 이어서 합니다.

사용법
aimz space flows | new <흐름> [--idea 글] [--photo 파일] | list | plan <번호> [--until 노드] | run <번호> [--until 노드] [-y]

관리자·고급

admin-status

(관리자) ComfyUI 워커·브로커 상태.

사용법
aimz admin-status

endpoints

서버 API 엔드포인트 검색.

사용법
aimz endpoints [검색어 …] [--method POST] [--admin]

api

서버 API 직접 호출. 자세히는 서버 API 직접 호출 문서.

사용법
aimz api <METHOD> <PATH> [-q 키=값 …] [-d JSON|@파일] [-y]

에이전트

tools

설치된 MCP 전체 도구의 이름·사용법·입력 JSON Schema를 조회합니다. 예: aimz tools production. 연결 방식과 서버 버전에 맞는 실제 규격을 먼저 확인하세요.

사용법
aimz tools [검색어]

call

MCP 기능을 같은 계정·확인 정책으로 호출합니다. JSON은 result에, 그림·소리는 content에 반환됩니다. --out은 반환 미디어를 저장하며 기존 파일을 덮어쓰지 않습니다. --yes는 이미 사용자가 승인한 범위의 확인에만 사용합니다.

사용법
aimz call <도구 이름> --data '@request.json' [--yes] [--out 새폴더]

agent

크레딧 사용 확인 정책.

사용법
aimz agent [status | mode ask|once|yolo | limit N|off | reset]

mcp

MCP 서버(stdio). 직접 실행하지 않고 에이전트 설정에 넣습니다.

사용법
aimz mcp

mcp-config

이 PC 경로가 들어간 Claude Code·Codex·Claude Desktop 설정을 출력합니다.

사용법
aimz mcp-config

-p 값 읽는 규칙

-p 키=값 은 여러 번 쓸 수 있습니다. 값이 숫자·true/false/null·JSON 배열/객체·따옴표 문자열이면 그 형식으로, 그 밖은 문자열로 보냅니다.

입력보내는 값
-p count=22 (숫자)
-p audio=truetrue
-p aspect_ratio=16:9"16:9" (문자열)
-p ref_images='["a.png","b.png"]'배열
--params-json '{"duration":5}'여러 값을 JSON 하나로. @파일 이름도 됩니다
참고
이미지·영상·오디오 입력 키(init_image, start_frame, ref_images …)에 이 PC 의 파일 경로를 주면 자동으로 업로드한 뒤 URL 로 바꿔 보냅니다. 파일 업로드·결과 저장 참고.

환경 변수

이름설명
AIMZ_SERVER기본 서버 주소
AIMZ_HOME설정 폴더 (기본 ~/.aimz)
AIMZ_CREDENTIAL_STOREkeyring | file — 토큰 저장소를 강제로 지정

종료 코드

0 성공 · 1 오류 · 2 사용법 · 3 사용자 확인 필요 · 4 로그인 필요. 자세히는 종료 코드·오류.