Guide
CLI 시작하기 — 설치부터 설정까지
Nylas CLI를 2분 안에 설정하세요. nylas init 마법사로 가입하면서 이메일을 연결하거나, 이미 있는 API 키로 nylas auth config를 실행해 로그인할 수 있습니다. 바로 이메일, 캘린더, 연락처를 터미널에서 관리하세요.
Written by Prem Keshari Senior SRE
Reviewed by Caleb Geene
Nylas CLI 설치 방법
Nylas CLI는 12MB 단일 정적 바이너리로, 런타임 의존성 없이 설치됩니다. 플랫폼에 맞는 방법을 선택하세요. 모든 방법이 CPU 아키텍처(x86_64 또는 arm64)를 자동 감지하고, GitHub에서 올바른 빌드를 다운로드하며, SHA-256 체크섬으로 검증합니다. 대부분의 네트워크에서 30초 이내에 설치가 완료됩니다.
Homebrew (macOS, Linux)
Homebrew formula는 nylas/nylas-cli 저장소를 탭하고 최신 안정 릴리스를 고정합니다. brew upgrade를 실행하면 자동으로 업그레이드됩니다.
brew install nylas/nylas-cli/nylas셸 스크립트 (macOS, Linux, WSL)
셸 인스톨러는 WSL을 포함한 모든 POSIX 시스템에서 작동합니다. 바이너리를 ~/.config/nylas/bin에 저장하고, 셸 프로필에 추가할 PATH export 줄을 출력합니다.
curl -fsSL https://cli.nylas.com/install.sh | bashPowerShell (Windows)
PowerShell 인스톨러는 Windows 바이너리를 다운로드하고 사용자 수준 PATH에 설치 디렉터리를 추가합니다. Windows 10 이상에 기본 포함된 PowerShell 5.1 이상이 필요합니다.
irm https://cli.nylas.com/install.ps1 | iexGo
소스에서 빌드하려면 Go 1.23 이상이 필요합니다. 바이너리는 $GOPATH/bin 디렉터리에 설치됩니다.
go install github.com/nylas/cli/cmd/nylas@latest어떤 방법으로 설치하든, 버전을 출력해서 바이너리가 PATH에 있는지 확인하세요:
nylas --version설치 후 Nylas CLI 설정 방법
설치 후 설정 경로는 두 가지입니다. 신규 사용자는 nylas init을 실행합니다. Nylas 계정을 만들고, 애플리케이션을 생성하고, API 키를 발급한 뒤 첫 이메일 계정까지 한 세션에서 연결하는 대화형 마법사입니다. 이미 API 키가 있다면 nylas auth config로 로그인하세요. 받은편지함은 nylas auth login으로 추가하며, 무료 플랜은 최대 5개 계정을 연결할 수 있습니다.
nylas init으로 설정하는 방법
nylas init 마법사는 신규 사용자에게 가장 빠른 경로입니다. Nylas 계정 로그인 또는 생성, 애플리케이션 선택 또는 생성, API 키 발급 및 활성화, 기존 이메일 계정 동기화의 네 단계를 하나의 대화형 세션에서 실행합니다. 약 90초가 걸리며 SSO 로그인을 위해 브라우저가 한 번 열립니다.
nylas init마법사는 SSO 제공업체(Google, Microsoft, GitHub)를 묻고, 애플리케이션과 키 생성을 거쳐 받은편지함을 연결합니다. 제공업체 선택 메뉴를 건너뛰려면 플래그를 직접 전달하세요:
nylas init --google
nylas init --microsoft
nylas init --github마법사가 끝나면 계정 인증과 이메일 연결이 완료됩니다. 받은편지함을 조회해서 확인하세요:
nylas email list기존 API 키로 로그인하는 방법
이미 Nylas Dashboard에서 API 키를 발급받았나요?nylas auth config를 실행하고 프롬프트에 키를 붙여넣어 로그인하세요. 4단계 마법사를 건너뜁니다. CLI는 1초 이내에 키를 검증하고 암호화해서 저장하며, 브라우저나 SSO 리디렉션이 없어 CI/CD 파이프라인, Docker 컨테이너, SSH 세션에 적합합니다.
nylas auth config비대화형 설정에서는 키를 플래그로 전달하고, 애플리케이션이 EU 리전에 있다면 --region eu를 추가하세요. 키는 nyl_로 시작합니다:
nylas auth config --api-key nyl_abc123
nylas auth config --api-key nyl_abc123 --region eu대시보드에서 API 키를 받는 방법
Nylas가 처음이지만 마법사보다 대시보드를 선호하나요? 세 단계로 API 키를 발급한 뒤 위의 nylas auth config로 로그인하세요. 무료 플랜에는 연결 계정 5개가 포함되며 신용카드가 필요 없습니다.
- 가입 — dashboard-v3.nylas.com에서 Google, Microsoft, GitHub SSO로 가입합니다.
- 애플리케이션 생성 — All apps를 열고 새 앱을 만든 뒤 리전(US 또는 EU)을 선택합니다.
- API 키 발급 — 앱의 API Keys 섹션을 열고 Create new key를 클릭합니다. 키는
nyl_로 시작합니다.
키로 로그인하면 CLI가 애플리케이션에 대해 인증되지만, 아직 받은편지함은 연결되지 않습니다. 첫 이메일 계정은 nylas auth login으로 연결하며, 이후 계정을 추가할 때도 같은 명령을 사용합니다(다음 섹션 참고).
이메일 계정 연결 방법
받은편지함은 nylas auth login으로 연결합니다. 무료 플랜은 Gmail, Outlook, Exchange, Yahoo, iCloud, IMAP에서 최대 5개 계정(그랜트라고 합니다)을 연결할 수 있습니다. 기본 제공업체는 Google이므로 옵션 없이 실행하면 Google 로그인이 시작되며, 나머지 다섯 개는 --provider로 지정합니다. CLI는 다음 명령 실행 시 새 그랜트를 자동으로 감지합니다.
# OAuth 제공업체 (브라우저가 열림)
nylas auth login --provider google
nylas auth login --provider microsoft
nylas auth login --provider ews
# 자격 증명 제공업체 (앱 전용 비밀번호)
nylas auth login --provider icloud
nylas auth login --provider yahoo
nylas auth login --provider imapGoogle의 OAuth 2.0 문서에 따르면 액세스 토큰은 3,600초 후 만료됩니다. CLI는 그랜트를 저장하고 토큰을 자동으로 갱신하므로 한 번만 권한을 부여하면 됩니다. 연결된 계정 목록 조회와 전환:
# 연결된 계정 목록 조회
nylas auth list
# 활성 계정 전환
nylas auth switchCLI에서 계정을 관리하는 방법
Nylas CLI는 웹 대시보드 기능의 약 90%를 nylas dashboard 하위 명령으로 제공합니다. 애플리케이션 생성, API 키 교체, 조직 전환, 로그인 상태 확인을 브라우저 없이 할 수 있습니다. 모든 하위 명령이 스크립팅용 --json 출력을 지원합니다.
자주 쓰는 대시보드 작업:
# 로그인 상태 확인
nylas dashboard status
# 애플리케이션 목록
nylas dashboard apps list
# 새 애플리케이션 생성
nylas dashboard apps create --name "Production App" --region us
# 애플리케이션을 활성으로 설정
nylas dashboard apps use app_abc123
# 새 API 키 생성
nylas dashboard apps apikeys create
# 조직 전환
nylas dashboard orgs switch이메일, 캘린더, 연락처 사용법
Nylas CLI는 72개 이상의 명령을 3가지 핵심 그룹으로 구성합니다: 이메일(보내기, 목록, 검색, 초안, 첨부), 캘린더(이벤트, 가용성, 일정 관리), 연락처(목록, 검색, 그룹). 각 그룹은 스크립팅용 --json 출력과 결과 수를 제어하는 --limit를 지원합니다. 설정 후 가장 많이 쓰는 명령:
# 이메일: 목록, 검색, 보내기
nylas email list --limit 5
nylas email search "quarterly report"
nylas email send --to colleague@company.com --subject "Quick note" --body "See you at 2pm."
# 캘린더: 이벤트 목록과 가용성 확인
nylas calendar events list --days 7
nylas calendar availability check --start 2026-05-12T09:00:00Z --end 2026-05-12T17:00:00Z --participants colleague@company.com
# 연락처: 목록과 검색
nylas contacts list --limit 10
nylas contacts search --query "Alice"
nylas contacts groups list아무 명령에 --json을 추가하면 jq로 파이프하거나 스크립트에 전달하거나 AI 에이전트로 보낼 수 있는 구조화된 출력을 얻습니다. 이메일 보내기 가이드와 캘린더 가이드에서 각 그룹의 자세한 내용을 확인하세요.
초기화하고 다시 시작하는 방법
Nylas CLI의 모든 설정은 ~/.config/nylas/에 로컬 저장됩니다. 보통 3~4개 파일, 합계 2KB 미만입니다. 초기화하면 API 인증 정보, Dashboard 세션 토큰, 인증된 그랜트, 설정 파일이 삭제되지만, Nylas Dashboard의 데이터나 서버 측 연결 계정에는 영향을 주지 않습니다. 애플리케이션, 그랜트, API 키는 클라우드에 그대로 남습니다.
로컬 설정을 지우고 다시 설정하기:
nylas config reset
nylas init--force를 붙이면 확인 프롬프트를 건너뜁니다. CLI를 자동으로 재설정하는 스크립트에서 유용합니다.
다음 단계
- 터미널에서 첫 이메일 보내기 — Gmail, Outlook, Exchange, Yahoo, iCloud, IMAP에서 한 줄로 전송, 예약 발송, JSON 출력
- CLI에서 캘린더 관리 — DST 대응 시간 처리와 빈 시간 조회로 이벤트 생성, 목록 조회, 업데이트
- MCP로 AI 에이전트에 이메일 접근 권한 부여 — 내장 MCP 서버로 받은편지함을 Claude, Cursor, Codex의 타입 지정 도구로 노출
- Nylas Agent Skills 설치 — 명령 하나로 Claude Code, Cursor, Codex CLI, Windsurf 등 30개 이상 에이전트에 CLI와 v3 API 사용법 교육
- AI 에이전트 감사 로그 설정 — 에이전트가 받은편지함에 수행하는 모든 도구 호출을 변조 방지 JSONL 로그에 기록
- 전체 명령 레퍼런스 보기 — 모든 명령, 하위 명령, 플래그를 카테고리별로 정리, --json 출력 예시 포함
- 이메일에서 OTP 코드 추출 — 받은편지함을 열지 않고 인증 코드 가져오기
- CLI에서 회의 녹음 — Zoom, Meet, Teams에 Notetaker 봇 보내기
- 인바운드 이메일 수신 — 관리형 주소 생성 및 웹훅으로 메시지 처리
- 이메일 인증: OAuth vs API 키 vs 앱 비밀번호 — 인증 방식 비교와 선택 기준
- 이메일을 JSON으로 백업 — 페이지네이션과 날짜 필터로 전체 메일함 내보내기
- Homebrew 문서 — macOS / Linux 권장 설치 방법을 지원하는 패키지 매니저
- Nylas CLI 릴리스 노트 (GitHub) — 공식 변경 이력, 서명된 체크섬, 플랫폼별 바이너리
- Google OAuth 2.0 토큰 만료 — Gmail 액세스 토큰이 3,600초 후 만료되는 이유와 Nylas의 자동 갱신 방식
- Microsoft ID 플랫폼 액세스 토큰 — Outlook, Exchange OAuth 흐름, 토큰 수명, 동의 화면
- RFC 6749 (OAuth 2.0) —
nylas auth login실행 시 CLI가 구현하는 프로토콜 사양