---
name: vibiz-get-started
area: Getting Started
supported_surfaces: [cli, skills, mcp]
description: |-
  Hand your coding agent this playbook to set up Vibiz: install the CLI, add
  the Vibiz agent skills, and connect the Vibiz MCP server once for use across
  projects.
title: 'Onboard your agent to Vibiz'
url: https://app.vibiz.app/get-started.md
---

# Set up Vibiz for your AI coding agent

Use this playbook to prepare the current agent for Vibiz: hosting, a Postgres database, sign-in, payments, email, social and AI for a new business, on one account. Install the CLI, the skills and the MCP connection once; create a project only when the person asks you to build something.

## How to run

Run section 1 once per machine. Run sections 2 and 3 once per coding agent.

For section 3, use `vibiz mcp add` first, and the route for your client below if it isn't supported. If neither covers it, adapt the closest route. If a step is blocked, record why and continue with the remaining steps.

Perform actions yourself when terminal or file access is available. Global or user-scoped installation is the default. Pause only for the person's sign-in, approval, or UI actions you cannot perform. Do not merely return commands for the person to copy. Never ask the person to paste a key into the chat.

## 1. Install the Vibiz CLI

Check for an existing installation:

```sh
vibiz --version
```

If the CLI is missing, install the latest version (Node.js 20+):

```sh
npm install --global @vibiz/cli@latest
vibiz --version
```

If a global install isn't possible, use `npx @vibiz/cli@latest` in place of `vibiz` for every command below.

Check who is signed in:

```sh
vibiz whoami
```

If no one is, run `vibiz login` (or `vibiz signup`; they are the same step). It prints a link and a short code and opens the browser. Show the person the link and ask them to sign in with their Vibiz account and click **Authorize**. A Vibiz Stack account is opened for them on the way if they have none. If your shell times out while it waits, run `vibiz login` again: it resumes the same code.

Pause while the person completes sign-in, then verify using:

```sh
vibiz whoami
```

Do not create a Vibiz project during global setup. Run `vibiz init` later, in the app's folder, when the person asks you to build something.

## 2. Add Vibiz guidance

The Vibiz agent skills teach the workflows for each product (deploy, database, sign-in, email, payments, social, connectors, company). Install them for the current agent:

```sh
vibiz skills list
vibiz skills add --global
vibiz skills list
```

`vibiz skills add` installs for the agent it runs in (Claude Code, Codex or Cursor). Pass `--agent claude|codex|cursor` to choose, and confirm the installation path it prints.

### Fallback: download the skills

If the CLI can't be used, unpack each skill from https://app.vibiz.app/skills/index.json into the agent's skills folder:

```sh
mkdir -p ~/.claude/skills
curl -fsSL https://app.vibiz.app/skills/vibiz-deploy.tar.gz | tar -xz -C ~/.claude/skills
```

| Agent | Personal (every project) |
| --- | --- |
| Claude Code | `~/.claude/skills` |
| Codex | `~/.agents/skills` |
| Cursor | `~/.cursor/skills` |

Reload only if the new skills don't show up.

## 3. Connect Vibiz MCP

Connect the shared Vibiz MCP endpoint once to reach projects, deployments, databases, payments, email, analytics and the docs across projects. It needs nothing installed: the client signs in over OAuth the first time it calls a tool.

If you know your client supports remote MCP with OAuth, use its route below. If it supports only stdio servers, configure the client's MCP server command as `npx` with arguments `["mcp-remote", "https://app.vibiz.app/mcp"]`, as in the Gemini CLI route. If unsure, try the route; record MCP as blocked only if it fails.

Before changing an MCP configuration file, inspect it and merge the `vibiz` entry without replacing unrelated settings.

For clients supported by the Vibiz CLI, configure the shared endpoint:

```sh
vibiz mcp add --clients "<client>"
```

Use the exact `<client>` value:

- Claude Code: `Claude Code`
- Codex: `Codex`
- Cursor: `Cursor`
- VS Code with GitHub Copilot: `VS Code with Copilot`
- Windsurf: `Windsurf`
- Gemini CLI: `Gemini CLI`
- OpenCode: `OpenCode`

It runs the client's own CLI where there is one (Claude Code, Codex) and otherwise merges the entry into the client's user config, never replacing other servers. Use only one route per client.

### Claude Code

Manual user-scoped fallback:

```bash
claude mcp add --transport http vibiz --scope user https://app.vibiz.app/mcp
```

Inspect existing MCP entries before adding (`claude mcp list`). To authenticate, open `/mcp`, select `vibiz`, and choose the authentication action.

### Codex CLI

First inspect:

```bash
codex mcp list
```

Its add command uses Codex's user-wide configuration:

```bash
codex mcp add vibiz --url https://app.vibiz.app/mcp
```

Codex should open a browser during setup. If the server exists but is not authenticated, run:

```bash
codex mcp login vibiz
```

### Cursor

Manual fallback: merge this into `~/.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "vibiz": {
      "url": "https://app.vibiz.app/mcp"
    }
  }
}
```

Cursor displays `Needs login` when authorization is required. Ask the person to click it.

### VS Code with GitHub Copilot

Run **MCP: Add Server**, choose **HTTP**, enter `https://app.vibiz.app/mcp`, name it `vibiz`, and select **Global**. Then run **MCP: List Servers**, start vibiz, and allow authentication.

### OpenCode

```bash
opencode mcp add vibiz --global --url https://app.vibiz.app/mcp
```

To authenticate, ask the person to run `/mcps` in OpenCode, select `vibiz`, and sign in.

### Windsurf

Merge this into `~/.codeium/windsurf/mcp_config.json`:

```json
{
  "mcpServers": {
    "vibiz": {
      "serverUrl": "https://app.vibiz.app/mcp"
    }
  }
}
```

Refresh the MCP configuration in Windsurf after saving.

### Gemini CLI

Merge this into `~/.gemini/settings.json`:

```json
{
  "mcpServers": {
    "vibiz": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://app.vibiz.app/mcp"
      ]
    }
  }
}
```

Run Gemini CLI and use `/mcp list` to load the server.

### Common authorization and verification

Before authorizing, verify the endpoint is exactly:

```text
https://app.vibiz.app/mcp
```

When a browser or consent screen opens, pause for the person to sign in and click **Authorize**. The connection gets its own agent key, named after the client, on the console's API keys page; revoking it there disconnects the client.

After authorization:

1. Call `vibiz_docs` with no topic (read-only: lists the guides).
2. Call the authenticated, read-only `vibiz_project_status` with no `project_id` (lists the person's projects; an empty list is fine).
3. Refresh the client's MCP tools or server list if either is unavailable.
4. Start or resume a session, or reload or restart the client, only if refreshing does not load the server.

Keep human confirmation enabled for every MCP mutation. Connecting MCP gives the agent an agent key: it can build, deploy and spend AI credits, but live money, real company filings and production secrets stay with the person. Errors carry `details.next_step`: pass it on.

## Completion

Report only verified state:

```text
◆ Vibiz agent setup is ready
CLI: <version>, signed in as <account>
Guidance: <skills|blocked: reason>, global or project scope, <path>
MCP: <connected|blocked: reason>, global shared endpoint, https://app.vibiz.app/mcp
MCP config: <path|managed by the client's CLI>
Authenticated MCP check: <vibiz_project_status succeeded|not requested>
Reload: <not needed|completed>
```

## Build something

When the person is ready, work in a new, empty folder and start from what they want. For example:

```text
Use Vibiz to build and deploy a small shop with sign-in, a database, a $9/month plan, welcome emails and AI product descriptions.
```

Run `vibiz init "<name>"` there (`--template nextjs-saas` for a starter app), `vibiz dev` for the development environment, and `vibiz deploy` to go live at `<slug>.vibiz.app`. Everything else is in https://app.vibiz.app/llms.txt.

Sources:

- https://app.vibiz.app/llms.txt
- https://app.vibiz.app/docs/quickstart
- https://app.vibiz.app/docs/agents
- https://app.vibiz.app/docs/cli
- https://app.vibiz.app/skills