larksuite/cli

larksuite 팀에서 관리하는 공식 Lark/Feishu CLI (Command Line Interface) 도구 — 인간과 AI 에이전트 (AI Agents)를 위해 구축되었습니다. Messenger, Docs, Base, Sheets, Slides, Calendar, Mail, Tasks, Meetings, Markdown 등을 포함한 핵심 비즈니스 도메인을 지원하며, 200개 이상의 명령어와 26개의 AI 에이전트 스킬 (AI Agent Skills)을 제공합니다.

설치 · AI 에이전트 스킬 (AI Agent Skills) · 인증 (Auth) · 명령어 (Commands) · 고급 (Advanced) · 보안 (Security) · 기여하기 (Contributing)

에이전트 네이티브 디자인 (Agent-Native Design)— 즉시 사용 가능한 24개의 구조화된 스킬을 제공하며, 인기 있는 AI 도구들과 호환됩니다 — 에이전트는 추가 설정 없이 Lark를 운영할 수 있습니다.
광범위한 커버리지 (Wide Coverage)— 18개의 비즈니스 도메인, 200개 이상의 큐레이션된 명령어, 26개의 AI 에이전트 스킬 (AI Agent Skills)
AI 친화적 및 최적화 (AI-Friendly & Optimized)— 모든 명령어는 실제 에이전트와 함께 테스트되었으며, 에이전트 호출 성공률을 극대화하기 위해 간결한 파라미터 (parameters), 스마트 기본값 (smart defaults), 구조화된 출력 (structured output)을 특징으로 합니다.
오픈 소스, 장벽 없는 사용 (Open Source, Zero Barriers)— MIT 라이선스, npm install만으로 즉시 사용 가능

3분 만에 실행하기 (Up and Running in 3 Minutes)— 원클릭 앱 생성, 대화형 로그인, 설치부터 첫 API 호출까지 단 3단계로 완료
안전하고 제어 가능한 (Secure & Controllable)— 입력 주입 방지 (Input injection protection), 터미널 출력 정화 (terminal output sanitization), OS 네이티브 키체인 자격 증명 저장 (OS-native keychain credential storage)
3계층 아키텍처 (Three-Layer Architecture)— Shortcuts (인간 및 AI 친화적) → API Commands (플랫폼 동기화) → Raw API (전체 커버리지)로 구성되어 적절한 입도 (granularity)를 선택할 수 있습니다.

카테고리	기능
📅 Calendar	일정 조회, 생성 및 업데이트, 참석자 초대, 회의실 찾기, 초대 응답 (RSVP), 여유 시간/바쁨 상태 확인 및 시간 제안
...

시작하기 전에 다음 사항이 준비되었는지 확인하세요:

Node.js (npm / npx)
Go v1.23 이상
Python 3 (소스 코드 빌드 시에만 필요)

AI 어시스턴트를 위한 참고 사항: 사용자의 설치를 돕는 AI 에이전트라면, 필요한 모든 단계가 포함된 Quick Start (AI Agent)로 바로 이동하세요.

다음 방법 중 하나를 선택하세요:

옵션 1 — npm을 통한 설치 (권장):

npx @larksuite/cli@latest install

옵션 2 — 소스 코드를 통한 설치:

Go v1.23 이상 및 Python 3가 필요합니다.

git clone https://github.com/larksuite/cli.git
cd cli
make install
...

# 1. 앱 자격 증명(app credentials) 설정 (1회성, 대화형 가이드 설정)
lark-cli config init
# 2. 로그인 (--recommend 옵션은 일반적으로 사용되는 스코프(scopes)를 자동 선택합니다)
...

다음 단계는 AI 에이전트(AI Agents)를 위한 것입니다. 일부 단계는 사용자가 브라우저에서 작업을 완료해야 합니다.

1단계 — 설치 (Install)

npx @larksuite/cli@latest install

2단계 — 앱 자격 증명(app credentials) 설정

이 명령어를 백그라운드에서 실행하십시오. 인증 URL(authorization URL)이 출력되면 이를 추출하여 사용자에게 전달하십시오. 사용자가 브라우저에서 설정을 완료하면 명령어가 자동으로 종료됩니다.

lark-cli config init --new

3단계 — 로그인 (Login)

위와 동일합니다: 백그라운드에서 실행하고, 인증 URL을 추출하여 사용자에게 전달하십시오.

lark-cli auth login --recommend

4단계 — 확인 (Verify)

lark-cli auth status

기술 (Skill)	설명
`lark-shared`	앱 설정, 인증 로그인, 신원 전환(identity switching), 스코프 관리(scope management), 보안 규칙 (다른 모든 기술에 의해 자동 로드됨)
`lark-calendar`	캘린더 일정 (생성/업데이트), 아젠다 보기, 시간 가능 여부(free/busy) 조회, 시간 제안, 회의실 찾기, RSVP 회신
`lark-im`	메시지 전송/회신, 그룹 채팅 관리, 메시지 검색, 이미지 및 파일 업로드/다운로드, 리액션
`lark-doc`	문서 생성, 읽기, 업데이트, 검색 (Markdown 기반)
`lark-drive`	파일 업로드, 다운로드, 권한 및 댓글 관리
`lark-markdown`	Drive 네이티브 Markdown 파일 생성, 가져오기, 패치(patch), 덮어쓰기
`lark-sheets`	스프레드시트 생성, 읽기, 쓰기, 추가, 찾기, 내보내기
`lark-slides`	프레젠테이션 생성 및 관리, 프레젠테이션 내용 읽기, 슬라이드 추가 또는 제거
`lark-base`	테이블, 필드, 레코드, 뷰, 대시보드, 데이터 집계 및 분석
`lark-task`	작업(Tasks), 작업 목록, 하위 작업, 알림, 멤버 할당
`lark-mail`	이메일 탐색, 검색, 읽기, 전송, 회신, 전달, 초안 관리, 새 메일 감시
`lark-contact`	이름/이메일/전화번호로 사용자 검색, 사용자 프로필 가져오기
`lark-wiki`	지식 공간(Knowledge spaces), 노드, 문서
`lark-event`

명령 (Command)	설명 (Description)
`auth login`	대화형 선택 또는 스코프 (scopes)를 위한 CLI 플래그를 사용한 OAuth 로그인
`auth logout`	로그아웃 및 저장된 자격 증명 제거
`auth status`	현재 로그인 상태 및 부여된 스코프 (scopes) 표시
`auth check`	특정 스코프 (scope) 확인 (종료 코드 0 = 정상, 1 = 누락)
`auth scopes`	앱에서 사용 가능한 모든 스코프 (scopes) 목록 표시
`auth list`	인증된 모든 사용자 목록 표시

# 대화형 로그인 (TUI가 도메인 및 권한 수준 선택을 안내함)
lark-cli auth login
# 도메인별 필터링
...

CLI는 빠른 작업부터 완전히 커스텀된 API 호출에 이르기까지 모든 것을 아우르는 세 가지 수준의 세분화된 기능을 제공합니다:

+로 접두사가 붙은 명령은 스마트한 기본값, 테이블 출력, 그리고 드라이 런 (dry-run) 미리보기를 제공하여 사람과 AI 모두에게 친화적으로 설계되었습니다.

lark-cli calendar +agenda
lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello"
lark-cli docs +create --api-version v2 --doc-format markdown --content '$'<title>Weekly Report</title>\n# Progress\n- Completed feature X'

모든 단축 명령을 확인하려면 lark-cli <service> --help를 실행하세요.

Lark OAPI 메타데이터로부터 자동 생성되었으며, 평가 및 품질 게이트 (quality gates)를 통해 큐레이션되었습니다 — 100개 이상의 명령어가 플랫폼 엔드포인트 (endpoints)와 1:1로 매핑되어 있습니다.

lark-cli calendar calendars list
lark-cli calendar events instance_view --params '{"calendar_id":"primary","start_time":"1700000000","end_time":"1700086400"}'

2,500개 이상의 API를 아우르는 모든 Lark Open Platform 엔드포인트를 직접 호출할 수 있습니다.

lark-cli api GET /open-apis/calendar/v4/calendars
lark-cli api POST /open-apis/im/v1/messages --params '{"receive_id_type":"chat_id"}' --data '{"receive_id":"oc_xxx","msg_type":"text","content":"{\"text\":\"Hello\"}"}'

--format json # 전체 JSON 응답 (기본값)
--format pretty # 사람이 읽기 편하게 포맷팅된 출력
--format table # 읽기 쉬운 테이블 형식
...

--page-all # 모든 페이지를 자동으로 페이지네이션 (paginate)
--page-limit 5 # 최대 5페이지
--page-delay 500 # 페이지 요청 간 500ms 간격

부수 효과 (side effects)가 발생할 수 있는 명령어의 경우, 먼저 --dry-run을 사용하여 요청을 미리 확인하세요:

lark-cli im +messages-send --chat-id oc_xxx --text "hello" --dry-run

schema를 사용하여 모든 API 메서드의 파라미터 (parameters), 요청 본문 (request body), 응답 구조 (response structure), 지원되는 신원 (identities) 및 스코프 (scopes)를 검사할 수 있습니다:

lark-cli schema
lark-cli schema calendar.events.instance_view
lark-cli schema im.messages.delete

이 도구는 AI 에이전트 (AI Agents)가 Lark/Feishu Open Platform의 작업을 자동화하기 위해 호출할 수 있으며, 모델 환각 (model hallucinations), 예측 불가능한 실행, 프롬프트 인젝션 (prompt injection)과 같은 내재적 위험을 수반합니다. Lark/Feishu 권한을 승인하면, AI 에이전트는 승인된 범위 내에서 귀하의 사용자 신원으로 동작하며, 이는 민감한 데이터 유출 또는 승인되지 않은 작업과 같은 고위험 결과로 이어질 수 있습니다. 주의해서 사용해 주시기 바랍니다.

이러한 위험을 줄이기 위해, 이 도구는 여러 계층에서 기본 보안 보호 기능을 활성화합니다. 하지만 이러한 위험은 여전히 존재합니다. 기본 보안 설정을 선제적으로 수정하지 않을 것을 강력히 권장합니다. 관련 제한 사항이 완화되면 위험이 크게 증가하며, 그 결과에 대한 책임은 사용자에게 있습니다.

이 도구와 통합된 Lark/Feishu 봇을 개인용 대화형 어시스턴트 (conversational assistant)로 사용하는 것을 권장합니다. 권한 오용이나 데이터 유출을 방지하기 위해, 봇을 그룹 채팅에 추가하거나 다른 사용자가 상호작용할 수 있도록 허용하지 마십시오.

모든 사용 위험을 충분히 이해하시기 바랍니다. 이 도구를 사용함으로써 귀하는 모든 관련 책임을 자발적으로 부담하는 것으로 간주됩니다.

커뮤니티 기여를 환영합니다! 버그를 발견하거나 기능 제안이 있는 경우, Issue 또는 Pull Request를 제출해 주세요.

주요 변경 사항에 대해서는 Issue를 통해 먼저 저희와 논의하는 것을 권장합니다.

이 프로젝트는 MIT License에 따라 라이선스가 부여됩니다.
실행 시 Lark/Feishu Open Platform API를 호출합니다. 이 API를 사용하려면 다음 약관 및 개인정보 보호정책을 준수해야 합니다:

larksuite/cli

요약

핵심 포인트

댓글