### Setup Script Examples for Node.js, Python, and Multiple Commands

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/settings/projects-repositories.mdx

Use setup scripts to prepare the development environment by installing dependencies, building prerequisites, or preparing the environment. These scripts run once when the workspace starts.

```bash
# Node.js project
npm install
```

```bash
# Python project
pip install -r requirements.txt
```

```bash
# Multiple commands
npm install && npm run build:deps
```

```bash
# Rust project
cargo fetch
```

--------------------------------

### Start Caddy with Example Configuration

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Run Caddy as a reverse proxy using the provided Caddyfile.example. This command should be run in a separate terminal from the repo root.

```bash
caddy run --config Caddyfile.example
```

--------------------------------

### Install and Run Qwen Code CLI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/qwen-code.mdx

Execute this command to install and run the Qwen Code command-line interface. Ensure you have Node.js and npm installed.

```bash
npx -y @qwen-code/qwen-code
```

--------------------------------

### Complete Workflow Example with MCP Tools

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/integrations/vibe-kanban-mcp-server.mdx

This sequence outlines a full project management workflow using various MCP tools for listing organizations, projects, issues, creating new issues, assigning tasks, and starting workspace sessions.

```text
1. List organisations to find the organisation ID
2. List projects in the organisation to find the project ID
3. List issues in the project filtered by status
4. Create a new issue for "Add user profile page"
5. Assign a team member to the issue
6. Start a workspace session for the issue using Amp on the develop branch
```

--------------------------------

### Install and Run OpenCode

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/opencode.mdx

Execute this command to install and run OpenCode. Follow the on-screen prompts for authentication.

```bash
npx -y opencode-ai
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/bloopai/vibe-kanban/blob/main/AGENTS.md

Run this command to install all necessary project dependencies before development.

```bash
pnpm i
```

--------------------------------

### Setup Session

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Runs the workspace setup script for a given session.

```APIDOC
## POST /api/sessions/{id}/setup — Run the workspace setup script

### Description
Runs the workspace setup script.

### Method
POST

### Endpoint
/api/sessions/{id}/setup

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the session.

### Response
Returns an ExecutionProcess for the setup script run.
```

--------------------------------

### Install Dependencies Step

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/AGENTS.md

Instructions for installing project dependencies using npm, with a verification step.

```bash
Run `npm install` to install required packages.

  <Check>
  Verify installation by running `npm list`.
  </Check>
```

--------------------------------

### Install Caddy using Homebrew

Source: https://github.com/bloopai/vibe-kanban/blob/main/mobile-testing.md

Installs the Caddy web server using the Homebrew package manager. Ensure Homebrew is installed before running this command.

```bash
brew install caddy
```

--------------------------------

### Install Web Companion Package

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/core-features/testing-your-application.mdx

Install the `vibe-kanban-web-companion` package using npm. This is required for precise component selection within the preview.

```bash
npm install vibe-kanban-web-companion
```

--------------------------------

### Start Local Development Server

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/README.md

Run this command at the root of your documentation project to start a local development server. Ensure your docs.json is present.

```bash
mint dev
```

--------------------------------

### Install and Launch CCR UI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/ccr.mdx

Use npx to install and launch the CCR local UI for configuring providers and models. No separate installation is required.

```bash
npx -y @musistudio/claude-code-router ui
```

--------------------------------

### Install and Run Gemini CLI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/gemini-cli.mdx

Execute this command to install and run the Gemini CLI. Follow the on-screen instructions for authentication.

```bash
npx -y @google/gemini-cli
```

--------------------------------

### Run Workspace Setup Script

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Executes the workspace setup script for a given session. This endpoint returns an ExecutionProcess object representing the setup run.

```bash
curl -X POST http://localhost:3000/api/sessions/sess-uuid-.../setup
```

--------------------------------

### Install GitHub Copilot CLI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/github-copilot.mdx

Run this command to install the GitHub Copilot CLI globally on your system.

```bash
npx -y @github/copilot
```

--------------------------------

### Install Cursor Agent CLI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/cursor-cli.mdx

Use this command to download and install the Cursor Agent CLI. Verify the installation by running `cursor-agent --version`.

```bash
curl https://cursor.com/install -fsS | bash
```

--------------------------------

### Install Mintlify CLI

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/README.md

Install the Mintlify CLI globally to preview documentation changes locally. This command is run in your terminal.

```bash
npm i -g mint
```

--------------------------------

### Start Docker Compose Services

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/self-hosting/local-development.mdx

Start the Vibe Kanban development stack using Docker Compose from the `crates/remote` directory. This command builds the images and starts all necessary services, including PostgreSQL, ElectricSQL, Remote Server, and Relay Server.

```bash
cd crates/remote
docker compose --env-file .env.remote -f docker-compose.yml up --build
```

--------------------------------

### Install Docker on Ubuntu/Debian

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/self-hosting/deploy-docker.mdx

Installs Docker and adds the current user to the docker group. Log out and back in for changes to take effect.

```bash
# Install Docker (Ubuntu/Debian)
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

# Log out and back in for group changes to take effect
```

--------------------------------

### Install OpenAI Codex

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/openai-codex.mdx

Run this command to install the OpenAI Codex CLI. Ensure Node.js and npm are installed.

```bash
npx -y @openai/codex
```

--------------------------------

### Install Caddy on Debian/Ubuntu

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Install Caddy using apt on Debian or Ubuntu systems.

```bash
# Debian/Ubuntu
sudo apt install caddy
```

--------------------------------

### Start Vibe Kanban Application

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/amp.mdx

Run this command to start the Vibe Kanban application after Amp has been set up and authenticated. Amp can then be selected for task attempts.

```bash
npx vibe-kanban
```

--------------------------------

### Install and Run Amp Agent

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/amp.mdx

Execute this command to install and run the Amp agent. Follow the on-screen prompts for authentication.

```bash
npx -y @sourcegraph/amp
```

--------------------------------

### Run Development Server

Source: https://github.com/bloopai/vibe-kanban/blob/main/AGENTS.md

Starts the backend and web app with auto-assigned ports for local development.

```bash
pnpm run dev
```

--------------------------------

### Example MCP Task Creation

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/core-features/creating-tasks.mdx

Use this example to create multiple tasks programmatically from a project description using an MCP client. The client automatically generates structured tasks based on the provided requirements.

```text
I need to implement user authentication with:
- Email/password registration
- Login with session management  
- Password reset functionality
- Email verification
- Protected route middleware

Please create individual tasks for each component.
```

--------------------------------

### Install Node.js and package with package managers

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/AGENTS.md

Use these commands to install Node.js and a package globally depending on your operating system.

```bash
brew install node
npm install -g package-name
```

```powershell
choco install nodejs
npm install -g package-name
```

```bash
sudo apt install nodejs npm
npm install -g package-name
```

--------------------------------

### Install Additional Development Tools

Source: https://github.com/bloopai/vibe-kanban/blob/main/README.md

Installs essential Rust-based development tools: `cargo-watch` for live reloading and `sqlx-cli` for database management.

```bash
cargo install cargo-watch
 cargo install sqlx-cli
```

--------------------------------

### Create and start a coding agent in a workspace

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

This endpoint creates a workspace and immediately starts a coding agent. It requires a name, repositories, executor configuration, a prompt for the agent, and optionally attachment IDs. The response includes details of the created workspace, session, and the initial execution process.

```bash
curl -X POST http://localhost:3000/api/workspaces/start \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Fix login bug",
    "repos": [{ "repo_id": "repo-uuid-ப்படாத", "target_branch": "main" }],
    "executor_config": {
      "executor": "CLAUDE_CODE",
      "variant": null,
      "model_id": null,
      "permission_policy": "auto_edit"
    },
    "prompt": "The login button on the homepage is broken. Investigate and fix it.",
    "attachment_ids": []
  }'
```

--------------------------------

### Local Web App Development

Source: https://github.com/bloopai/vibe-kanban/blob/main/AGENTS.md

Starts the local web application in development mode.

```bash
pnpm run local-web:dev
```

--------------------------------

### Manually Start Remote Service with Docker Compose

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Manually start the remote service, database, and Electric using Docker Compose. Ensure the .env.remote file is configured.

```bash
cd crates/remote
docker compose --env-file .env.remote up --build
```

--------------------------------

### Get System Info

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Retrieve system information including version, configuration, login status, and environment details using a GET request to /api/info. The response is typically parsed with jq.

```bash
curl http://localhost:3000/api/info | jq .
```

```json
{
  "success": true,
  "data": {
    "version": "0.1.44",
    "config": {
      "git_branch_prefix": "vibe/",
      "relay_enabled": false,
      "analytics_enabled": true,
      "editor": "CURSOR",
      "executor_profile": "CLAUDE_CODE"
    },
    "machine_id": "a1b2c3d4-...",
    "login_status": { "type": "logged_in", "profile": { "username": "alice" } },
    "environment": {
      "os_type": "Darwin",
      "os_version": "14.4",
      "os_architecture": "arm64",
      "bitness": "64-bit"
    },
    "capabilities": {
      "CLAUDE_CODE": ["SESSION_FORK"]
    }
  }
}
```

--------------------------------

### Start Workspace Session Configuration

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/integrations/vibe-kanban-mcp-server.mdx

This JSON object defines the parameters for starting a workspace session, including the issue name, coding agent, and repository information.

```json
{
  "name": "User registration with email validation",
  "executor": "claude-code",
  "repositories": [
    {
      "repo_id": "987fcdeb-51a2-3d4e-b678-426614174001",
      "branch": "main"
    }
  ],
  "issue_id": "123e4567-e89b-12d3-a456-426614174000"
}
```

--------------------------------

### Create workspace and start a coding agent

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Creates a new workspace and immediately starts a coding agent to address a specific prompt.

```APIDOC
## POST /api/workspaces/start — Create workspace and start a coding agent

### Description
Creates a new workspace and starts a coding agent to address a specific prompt. The response includes details about the created workspace, session, and the initial execution process.

### Method
POST

### Endpoint
/api/workspaces/start

### Request Body
- **name** (string) - Required - The name of the workspace.
- **repos** (array) - Required - A list of repositories to associate with the workspace.
  - **repo_id** (string) - Required - The ID of the repository.
  - **target_branch** (string) - Required - The target branch for the repository.
- **executor_config** (object) - Required - Configuration for the executor.
  - **executor** (string) - Required - The type of executor (e.g., "CLAUDE_CODE").
  - **variant** (string | null) - Optional - The executor variant.
  - **model_id** (string | null) - Optional - The model ID to use.
  - **permission_policy** (string) - Required - The permission policy for the executor (e.g., "auto_edit").
- **prompt** (string) - Required - The prompt for the coding agent.
- **attachment_ids** (array) - Optional - A list of attachment IDs.

### Request Example
```json
{
  "name": "Fix login bug",
  "repos": [{ "repo_id": "repo-uuid-.", "target_branch": "main" }],
  "executor_config": {
    "executor": "CLAUDE_CODE",
    "variant": null,
    "model_id": null,
    "permission_policy": "auto_edit"
  },
  "prompt": "The login button on the homepage is broken. Investigate and fix it.",
  "attachment_ids": []
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the workspace, session, and execution process details.
  - **workspace** (object) - Details of the created workspace.
  - **session** (object) - Details of the created session.
  - **execution_process** (object) - Details of the initial execution process.

### Response Example
```json
{
  "success": true,
  "data": {
    "workspace": { "id": "550e8400-.", "branch": "vibe/fix-login-bug", ... },
    "session": { "id": "sess-uuid-.", ... },
    "execution_process": { "id": "exec-uuid-.", "status": "running", ... }
  }
}
```
```

--------------------------------

### Run Remote Development Server

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/AGENTS.md

Starts the remote development server for Vibe Kanban. Ensure you are in the repository root.

```bash
# (from the repo root)
pnpm run remote:dev
```

--------------------------------

### Start Remote Service Development

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Run the remote service in development mode from the repository root.

```bash
pnpm run remote:dev
```

--------------------------------

### Code Formatting Script Examples

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/settings/projects-repositories.mdx

Automate code formatting and linting as part of cleanup scripts to maintain consistent code style. Examples include Prettier, ESLint, Black, Ruff, and Go fmt.

```bash
# JavaScript/TypeScript (Prettier)
npx prettier --write .
```

```bash
# JavaScript/TypeScript (ESLint)
npx eslint --fix .
```

```bash
# Rust (cargo fmt)
cargo fmt
```

```bash
# Rust (Clippy)
cargo clippy --fix --allow-dirty
```

```bash
# Python (Black)
black .
```

```bash
# Python (Ruff)
ruff check --fix .
```

```bash
# Go
go fmt ./...
```

--------------------------------

### Install Caddy on macOS

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Install Caddy using Homebrew on macOS.

```bash
# macOS
brew install caddy
```

--------------------------------

### JSON Response Example

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/AGENTS.md

Example of a successful JSON response from an API, detailing user information.

```json
{
  "id": "user_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}
```

--------------------------------

### MCP Tool: Start Workspace

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Use the `start_workspace` tool to create a new workspace and initiate a coding agent session. Specify the workspace name, prompt, executor, and optionally repositories and issue ID.

```json
{
  "tool": "start_workspace",
  "arguments": {
    "name": "Fix login button",
    "prompt": "The login button on /dashboard is broken. Investigate and fix it.",
    "executor": "CLAUDE_CODE",
    "repositories": [
      { "repo_id": "repo-uuid-...", "branch": "main" }
    ],
    "issue_id": "issue-uuid-..."
  }
}
```

--------------------------------

### Install Droid CLI (Windows)

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/droid.mdx

Installs the Droid CLI using an Invoke-RestMethod command for Windows systems.

```powershell
irm https://app.factory.ai/cli/windows | iex
```

--------------------------------

### Launch Vibe Kanban Desktop App

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Use the NPX CLI with the --desktop flag to launch the Tauri desktop application.

```bash
npx vibe-kanban --desktop
```

--------------------------------

### Configure Environment Step

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/AGENTS.md

Instructions for configuring environment variables by creating a .env file, including a warning about API key security.

```bash
Create a .env file with your API credentials.

  ```bash
  API_KEY=your_api_key_here
  ```

  <Warning>
  Never commit API keys to version control.
  </Warning>
```

--------------------------------

### Install Droid CLI (macOS/Linux)

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/droid.mdx

Installs the Droid CLI using a curl command for macOS and Linux systems.

```bash
curl -fsSL https://app.factory.ai/cli | sh
```

--------------------------------

### Run Relay Test Client

Source: https://github.com/bloopai/vibe-kanban/blob/main/scripts/relay-test-client/README.md

Execute this command from the repository root to start a local HTTP server for the relay test client. Access the client via the specified URL in your browser.

```bash
python3 -m http.server 8787 --directory scripts/relay-test-client
```

--------------------------------

### Install Azure DevOps Extension

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/integrations/azure-repos-integration.mdx

Installs the Azure DevOps extension for the Azure CLI, which is required for repository and pull request commands.

```bash
az extension add --name azure-devops
```

--------------------------------

### Build Web App

Source: https://github.com/bloopai/vibe-kanban/blob/main/README.md

Compiles the web application assets. Navigate to the `packages/local-web` directory before running.

```bash
cd packages/local-web
pnpm run build
```

--------------------------------

### Install Claude Code Agent

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/agents/claude-code.mdx

Run this command to install the Claude Code agent globally. Follow the on-screen prompts for authentication.

```bash
npx -y @anthropic-ai/claude-code
```

--------------------------------

### cURL Request Example

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/AGENTS.md

Example of a cURL command for making a POST request to an API endpoint, including headers and data payload.

```bash
curl -X POST 'https://api.example.com/users' \
  -H 'Content-Type: application/json' \
  -d '{"name": "John Doe", "email": "john@example.com"}'
```

--------------------------------

### MCP Tool: start_workspace

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Creates a new workspace and immediately starts a coding agent session within it. Requires a name, prompt, executor, and optionally repositories and an issue ID.

```APIDOC
## MCP Tool: start_workspace

### Description
Create a new workspace and immediately start a coding agent session.

### Request Body
```json
{
  "tool": "start_workspace",
  "arguments": {
    "name": "string",
    "prompt": "string",
    "executor": "string",
    "repositories": [
      {
        "repo_id": "string",
        "branch": "string"
      }
    ],
    "issue_id": "string"
  }
}
```

### Response
#### Success Response (200)
- **workspace_id** (string) - The ID of the newly created workspace.

### Response Example
```json
{
  "workspace_id": "550e8400-..."
}
```
```

--------------------------------

### Connect Desktop Client to Local Server

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/self-hosting/local-development.mdx

Configure the desktop client to connect to your locally running Vibe Kanban Cloud instance. Set the `VK_SHARED_API_BASE` environment variable to point to your local server.

```bash
# In a new terminal, from the repository root
export VK_SHARED_API_BASE=http://localhost:3000

pnpm install
pnpm run dev
```

--------------------------------

### Perform Signed GET Request

Source: https://github.com/bloopai/vibe-kanban/blob/main/scripts/relay-test-client/index.html

Executes a GET request to a specified path on the relay server, including authentication headers with a signature. Verifies the server's response signature.

```javascript
async function signedGetJson(
  sessionPrefix,
  path,
  signingSessionId,
  browserPrivateKey,
  serverPublicKey,
) {
  const timestamp = Math.floor(Date.now() / 1000);
  const nonce = randomNonce();
  const bodyHash = await sha256Base64(new Uint8Array(0));
  const message = `v1|${timestamp}|GET|${path}|${signingSessionId}|${nonce}|${bodyHash}`;
  const signatureBytes = await ed25519Sign(browserPrivateKey, encoder.encode(message));
  const requestSignatureB64 = bytesToBase64(signatureBytes);
  const response = await fetch(`${sessionPrefix}${path}`, {
    method: "GET",
    headers: {
      "x-vk-sig-session": signingSessionId,
      "x-vk-sig-ts": String(timestamp),
      "x-vk-sig-nonce": nonce,
      "x-vk-sig-signature": requestSignatureB64,
    },
  });
  const responseBytes = new Uint8Array(await response.arrayBuffer());
  const text = decoder.decode(responseBytes);
  await verifySignedRelayResponse(
    response,
    responseBytes,
    path,
    signingSessionId,
    nonce,
    serverPublicKey,
  );
  let json = null;
  if (text) {
    try {
      json = JSON.parse(text);
    } catch {
      json = null;
    }
  }
  return { response, text, json };
}
```

--------------------------------

### Run Dev Mode with Vite

Source: https://github.com/bloopai/vibe-kanban/blob/main/mobile-testing.md

Start the development environment using Vite for hot reloading. This involves running the backend in Docker, the frontend with Vite, and Caddy for proxying.

```bash
# Terminal 1 — Docker backends (no frontend build needed)
PUBLIC_BASE_URL=https://$TS_HOSTNAME:3001 \
pnpm remote:dev

# Terminal 2 — Vite dev server (hot reload)
VITE_RELAY_API_BASE_URL=https://$TS_HOSTNAME:8443 \
pnpm --filter @vibe/remote-web dev

# Terminal 3 — Caddy (dev config)
caddy run --config Caddyfile.dev

# Terminal 4 (optional) — Local desktop client
VK_SHARED_API_BASE=https://$TS_HOSTNAME:3001 \
VK_SHARED_RELAY_API_BASE=https://$TS_HOSTNAME:8443 \
pnpm run dev
```

--------------------------------

### Start Full Remote Service Development

Source: https://github.com/bloopai/vibe-kanban/blob/main/crates/remote/README.md

Run the full remote service stack, including relay and local attachment storage, in development mode.

```bash
pnpm run remote:dev:full
```

--------------------------------

### Docker Compose Deployment Commands

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/self-hosting/deploy-docker.mdx

Commands to build and start the Vibe Kanban services in production using Docker Compose. It utilizes an environment file for configuration and starts services in detached mode.

```bash
cd crates/remote

# Build and start all services
docker compose --env-file ../../.env.remote -f docker-compose.prod.yml up -d --build

# View logs
docker compose -f docker-compose.prod.yml logs -f

```

--------------------------------

### Create a workspace

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Use this endpoint to create a new workspace. It requires a name and a list of repositories with their target branches. Optionally, linked issues can be provided.

```bash
curl -X POST http://localhost:3000/api/workspaces \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Implement user dashboard",
    "repos": [
      { "repo_id": "repo-uuid-ப்படாத", "target_branch": "main" }
    ],
    "linked_issue": {
      "remote_project_id": "proj-uuid-ப்படாத",
      "issue_id": "issue-uuid-ப்படாத"
    }
  }'
```

--------------------------------

### Example: Rebase Onto Main Branch

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/core-features/resolving-rebase-conflicts.mdx

This example demonstrates rebasing your work onto the 'main' branch when it was accidentally based on 'develop'. It uses a specific commit hash to identify the point before your work began.

```bash
# Find the last commit before your work started (e.g., in the git log)
# Then rebase only your commits onto main
git rebase 64d504c94d076070d17affd3f84be63b34515445 --onto main
```

--------------------------------

### Vibe Kanban CLI Help and Version

Source: https://github.com/bloopai/vibe-kanban/blob/main/npx-cli/README.md

Access help information and check the version for Vibe Kanban and its subcommands using these npx commands.

```bash
npx vibe-kanban --help
```

```bash
npx vibe-kanban --version
```

```bash
npx vibe-kanban review --help
```

```bash
npx vibe-kanban mcp --help
```

--------------------------------

### Get MCP Server Configuration

Source: https://context7.com/bloopai/vibe-kanban/llms.txt

Retrieve the MCP server configuration for a specific executor by making a GET request to /api/config/mcp-config with an executor query parameter. This endpoint returns details about server paths and configurations.

```bash
curl "http://localhost:3000/api/config/mcp-config?executor=CLAUDE_CODE" | jq .
```

```json
{
  "success": true,
  "data": {
    "mcp_config": {
      "servers_path": ["mcpServers"],
      "servers": {
        "vibe-kanban": {
          "command": "npx",
          "args": ["vibe-kanban", "mcp"]
        }
      }
    },
    "config_path": "/Users/alice/.claude/claude_desktop_config.json"
  }
}
```

--------------------------------

### Restart Electric Service with Environment File

Source: https://github.com/bloopai/vibe-kanban/blob/main/docs/self-hosting/local-development.mdx

Restarts the Electric service, applying environment variables from a specified file. Use this if ElectricSQL fails to connect after initial setup.

```bash
docker compose --env-file .env.remote -f docker-compose.yml restart electric
```