Skip to main content
This guide installs the desktop, adds an Agent, opens a project directory, and has the Agent finish a small, reviewable task. For your first try, use a throwaway Git repository.

1. Install the desktop

Download the installer for your platform from GitHub Releases and install it. Full instructions and platform caveats are in Install.
macOS and Windows packages are currently unsigned, so the first launch is blocked by Gatekeeper or SmartScreen. See Install for the exact steps.

2. Add an Agent

On first launch Vibex shows the Start something new page. With no available Agent it says No Agent has been added. Open Config Center to add one. Click Add Agent to open the Config Center.
  1. Find the Agent in the Agents list. Built-in presets include Claude Code, Codex, ZCode, and OpenCode, plus a dozen ACP integrations.
  2. Click + on the right to add it. The row then shows an enable switch.
  3. If the Agent is managed by Vibex and not installed, the card shows Install. Click it to download and verify the runtime; it cannot be cancelled midway, and the button becomes Check for updates when done.
  4. If the row says User-managed, the Agent is not in the managed directory and Vibex uses the command on your PATH—install it yourself first.
Then open the Native credentials card to sign in (Sign in / Open sign-in terminal), or add your own address, key, and models under Model provider configuration.
An Agent can have several provider profiles. Shared Providers and route groups live under Config Center → Providers; see Providers, route groups, and the local gateway.

3. Open a project directory

  1. Click New project in the sidebar, or use Project directory on the New session page.
  2. Choose the repository root in the directory browser and confirm.
  3. For your first try, use a test branch or a temporary repository—the Agent really writes to disk.
You can also choose Temporary session to try a prompt without binding a project.

4. Complete your first session

  1. At the top of the composer, choose the Agent, provider profile, model, and Thinking depth.
  2. Enter a focused task, for example “Add install steps to README.md, and show the plan first”.
  3. Watch the plan and tool calls in the timeline. When the Agent needs a file, a terminal, or permission, Vibex shows the request; choose Allow or Deny.
  4. When the Agent finishes, open the Git panel, review Changes, and decide whether to commit or keep asking.
For the first task, ask for a plan before allowing file changes. That lets you confirm scope and risk in the timeline.
Stop only stops the run; it does not roll back files or commands already executed. Check the Git diff and the terminal separately.

The composer

You can combine several kinds of context: Before sending you can choose the Agent, provider profile, model, thinking depth, conversation mode, and the built-in tools available to this session. Different Agents expose different options; the UI shows what the runtime probe reports. A message written while a turn is running goes into the queue. You can edit it, delete it, steer the running turn, or schedule it for a later hour.

5. Try the terminal client

The TUI ships with the desktop package. From a project directory:
It attaches to the same runtime; vibex status shows which runtime it would use. See Vibex TUI.

Next