Your first session
Install Vibes, connect a provider, and start working in a repository.
Before you start
You need Bun 1.3 or newer, Git, and a model-provider API key. Vibes currently installs from a checkout; a standalone cross-platform binary is not shipped.
bun --version
git --version01 — Install from source
git clone https://github.com/manyeya/vibes.git
cd vibes
bun install
bun linkbun link makes the vibes command available. Keep this checkout: the launcher uses its API and terminal application.
02 — Connect a model
vibes login OPENAI_API_KEYThe login prompt hides your input. You can use AI_GATEWAY_API_KEY, ZHIPU_API_KEY, OPENAI_API_KEY, or OPENROUTER_API_KEY. Running vibes login without a name defaults to OpenRouter.
Run vibes keys to inspect the storage backend and saved key names. It does not print the keys themselves.
03 — Open your project
cd ~/projects/your-project
vibesThe launcher starts a local API on an available port and opens the terminal interface in your current directory. Runtime data lives under ~/.vibes/. The API stops when the launcher exits.
“Explain how this project is organized. Identify the main entry points and suggest a small improvement.”
Choose how much autonomy to give
Use plan to explore without edits, manual to approve each edit or command, auto-edit to allow file changes while reviewing commands, or auto for autonomous execution.
Compare execution modes ↗If something does not start
- Command not found: run
bun linkin the Vibes checkout and ensure Bun’s bin directory is on your PATH. - No model-provider key: run
vibes keys, thenvibes loginfor your provider. - API or terminal startup: inspect
~/.vibes/vibes-cli.log. - Custom installation: use
--homeor--api-urlas described in the CLI reference.