Getting Started
Install & Configure Paean CLI
Get up and running with Paean CLI in under 5 minutes. This guide covers installation, authentication, and your first interaction.
1Installation
Paean CLI is available as an npm package. We recommend using bun for faster installation.
Recommended (Bun)
$ bun add -g paean
Alternative (npm)
$ npm install -g paean
Run without installing
$ npx paean
Requirements: Node.js 18+ or Bun runtime, and a Paean AI account.
2Authentication
Log in to connect your CLI with your Paean account. This enables cloud sync for tasks, moments, and preferences.
$ paean login
This opens your browser for secure OAuth authentication. Once complete, your credentials are stored locally in ~/.paean/config.json.
Don't have an account? Create one at app.paean.ai
3Quick Start
Start an interactive session with your AI agent:
Interactive Mode
$ paean
# Opens interactive chat with project context
For complex projects, enable planning mode for pre-flight analysis:
Planning Mode
$ paean --plan
# Analyzes project structure before starting
Execute a task without entering chat:
Quick Prompt
$ paean prompt "Analyze the current project structure"