CLI reference
DOCS / START HERE

CLI reference

Launch anywhere. Manage providers. Keep the setup simple.

Launch options

shell
vibes [--port <number>] [--home <directory>] [--api-url <url>]
OptionBehavior
--help, -hPrint command help.
--version, -vPrint the installed checkout version.
--port <n>Choose the local API port instead of an available ephemeral port.
--home <dir>Use a custom state directory. The default is ~/.vibes; VIBES_HOME can also configure it.
--api-url <url>Connect to an existing API instead of starting one.

Credential commands

shell
vibes login                     # OpenRouter by default
vibes login OPENAI_API_KEY      # Choose a provider
vibes keys                      # List names, not values
vibes keys add OPENAI_API_KEY
vibes keys rm OPENAI_API_KEY
vibes logout                    # Clear stored credentials

Environment variables take precedence over saved keys. Desktop systems use the OS keychain when available; the fallback is an encrypted file under the Vibes home directory.

Read configuration and storage details →

Run the apps separately

shell
bun run dev:api
# In another terminal:
bun run dev:tui
# Or use the web interface:
bun run dev:demo

The development API defaults to port 3000. The web app proxies /api/* to it. The terminal development command expects that API to be running.

Build local bundles

shell
bun run vibes:build

This bundles the API and terminal entry points into dist/. The launcher prefers these bundles when present. OpenTUI’s native renderer remains a runtime dependency.

Improve this page Grounded in the Vibes source.

Find a guide, command, or concept.