​
Getting Started

Install Pllan, run onboarding, and chat with your AI assistant — all in about 5 minutes. By the end you will have a running Gateway, configured auth, and a working chat session.

​
What you need

  • Node.js — Node 24 recommended (Node 22.16+ also supported)
  • An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you
Check your Node version with node --version. Windows users: both native Windows and WSL2 are supported. WSL2 is more stable and recommended for the full experience. See Windows. Need to install Node? See Node setup.

​
Quick setup

1

Install Pllan

curl -fsSL https://pllan.ai/install.sh | bash
Install Script Process
Other install methods (Docker, Nix, npm): Install.
2

Run onboarding

pllan onboard --install-daemon
The wizard walks you through choosing a model provider, setting an API key, and configuring the Gateway. It takes about 2 minutes.See Onboarding (CLI) for the full reference.
3

Verify the Gateway is running

pllan gateway status
You should see the Gateway listening on port 18789.
4

Open the dashboard

pllan dashboard
This opens the Control UI in your browser. If it loads, everything is working.
5

Send your first message

Type a message in the Control UI chat and you should get an AI reply.Want to chat from your phone instead? The fastest channel to set up is Telegram (just a bot token). See Channels for all options.

​
What to do next

Connect a channel

WhatsApp, Telegram, Discord, iMessage, and more.

Pairing and safety

Control who can message your agent.

Configure the Gateway

Models, tools, sandbox, and advanced settings.

Browse tools

Browser, exec, web search, skills, and plugins.
If you run Pllan as a service account or want custom paths:
  • PLLAN_HOME — home directory for internal path resolution
  • PLLAN_STATE_DIR — override the state directory
  • PLLAN_CONFIG_PATH — override the config file path
Full reference: Environment variables.