Docs/Getting Started/Quickstart
Getting Started

Quickstart

The fastest path from nothing to a working agent β€” install, pick a provider, open the chat β€” in under two minutes.

1. Install

curl -fsSL https://useflowlyapp.com/install.sh | bash   # recommended (macOS / Linux)
# Windows: irm https://useflowlyapp.com/install.ps1 | iex
# or a packaged PyPI install: uv tool install flowly-ai

The native script manages Python for you (via uv) and installs a git checkout, so flowly update can pull new versions between releases. The packaged uv tool / pip installs need Python β‰₯ 3.11 and track PyPI. Works on macOS, Linux, and Windows. See Installation for all methods.

2. Pick a provider

flowly setup

flowly setup opens the first-run picker. Choose how to power Flowly: sign in with a Flowly account (managed, nothing else to configure) or bring your own API key (OpenRouter, Anthropic, OpenAI, Gemini, Groq, xAI, Sakana β€” plus Zhipu and a self-hosted vLLM endpoint via the advanced picker). Configuring one of these is the only mandatory step β€” everything else (channels, tools, integrations) is optional. On a fresh install this picker also opens automatically right after curl … | bash.

If you already have a key and want to skip the picker, do it in one shot:
flowly setup byok anthropic --key sk-ant-...

See Setup wizard for all subcommands.

3. Chat

flowly

Bare flowly opens the terminal chat. Type a message and the agent responds. Inside the chat you can switch provider and model on the fly:

/provider openrouter
/model claude-sonnet-4-5

See Terminal UI for slash commands and session history.

One-shot prompts

For scripting or a single question without entering the TUI, use flowly agent:

flowly agent -m "Summarize the README in this directory"

Where to next