ddb21f969d
* I have explored the codebase and confirmed that the GitHub integration now relies on the `gh` CLI instead of a Personal Access Token (PAT) configured in the settings. The setup process is "just-in-time", prompting the user to install or authenticate the CLI when they attempt to create a Pull Request. I have updated the documentation to reflect these changes: 1. **`docs/integrations/github-integration.mdx`**: Rewrote the guide to explain the CLI-based workflow, including automatic setup on macOS and manual setup instructions for other platforms, as well as troubleshooting steps. 2. **`docs/getting-started.mdx`**: Updated the installation steps to remove the instruction to "Connect to GitHub in Settings" and instead mention the `gh` CLI requirement. 3. **`docs/configuration-customisation/global-settings.mdx`**: Removed the "GitHub Integration" section (since it no longer exists in Global Settings) and replaced it with a "Git Configuration" section describing the "Branch Prefix" setting, which is present in the UI. I also verified that `docs/core-features/completing-a-task.mdx` remains accurate with the new workflow. No images were needed as the process is now primarily CLI-driven or standard dialog-based, and I removed the outdated screenshots from the documentation files. I ran `pnpm run check` to ensure no regressions were introduced, and it passed successfully. ### Summary of Changes | File | Change | | :--- | :--- | | `docs/integrations/github-integration.mdx` | Rewritten to document `gh` CLI usage and troubleshooting | | `docs/getting-started.mdx` | Removed outdated "Connect GitHub" step; added CLI info | | `docs/configuration-customisation/global-settings.mdx` | Removed GitHub section; added Git Branch Prefix section | * The "Troubleshooting" section has been removed from `docs/integrations/github-integration.mdx`. * I have performed a comprehensive search for "github" across the documentation and codebase. I found and updated a few more references to ensure consistency: 1. **`docs/core-features/completing-a-task.mdx`**: Updated the link text to "Set up GitHub CLI integration" instead of "Set up GitHub authentication". 2. **`docs/index.mdx`**: Updated the Settings card description to remove "GitHub integration" and replace it with "git settings". 3. **`docs/configuration-customisation/global-settings.mdx`**: Updated the alt text of the settings screenshot to remove the mention of "GitHub integration settings". I verified other references in `docs/core-features/creating-tasks.mdx`, `docs/core-features/monitoring-task-execution.mdx`, and `docs/supported-coding-agents.mdx` and confirmed they are either correct (referring to platform features like polling or agents like Copilot) or generic examples that don't need changing. The documentation now fully reflects the shift to the CLI-based GitHub integration workflow.
72 lines
2.5 KiB
Plaintext
72 lines
2.5 KiB
Plaintext
---
|
|
title: "Install & Run Vibe Kanban"
|
|
description: "Complete installation guide for Vibe Kanban on macOS, Linux, and Windows"
|
|
sidebarTitle: "Installation"
|
|
---
|
|
|
|
## Supported Systems
|
|
|
|
We build and test Vibe Kanban on the following systems:
|
|
|
|
- macOS (Intel and Apple Silicon)
|
|
- Linux
|
|
- Windows
|
|
|
|
## Prerequisites
|
|
|
|
Before installing Vibe Kanban, ensure you have:
|
|
|
|
- **Node.js**: Latest LTS version recommended
|
|
- **Coding agent authentication**: Authenticate with your preferred coding agents outside of Vibe Kanban
|
|
|
|
## Safety Notice
|
|
|
|
<Warning>
|
|
Vibe Kanban runs AI agents with --dangerously-skip-permissions/--yolo flags by default so they can work autonomously without constant approval prompts. Each task runs in an isolated git worktree, preventing agents from interfering with each other.
|
|
Agents can still perform system-level actions, so review their work and keep backups.
|
|
</Warning>
|
|
|
|
## Installation & Setup
|
|
|
|
<Steps>
|
|
<Step title="Authenticate with a coding agent">
|
|
Before launching Vibe Kanban, ensure you're authenticated with at least one [supported coding agent](/supported-coding-agents). Follow the installation and authentication instructions for your preferred agent.
|
|
</Step>
|
|
|
|
<Step title="Install and launch Vibe Kanban">
|
|
Open a terminal and run:
|
|
|
|
```bash
|
|
npx vibe-kanban
|
|
```
|
|
|
|
<Check>
|
|
The application will bind to a random free port, print the URL in the terminal, and automatically open in your default browser.
|
|
</Check>
|
|
</Step>
|
|
|
|
<Step title="Complete initial setup">
|
|
Complete the setup dialogs to configure your coding agent and editor preferences. GitHub integration relies on the GitHub CLI and is configured when needed.
|
|
</Step>
|
|
|
|
<Step title="Create your first project">
|
|
You'll land on the Projects page, populated with your three most recently active git projects if automatically discovered. Click "Create project" to add more projects.
|
|
</Step>
|
|
|
|
<Step title="Add tasks">
|
|
Start tracking your work by [creating tasks](/core-features/creating-tasks) within your project.
|
|
</Step>
|
|
|
|
<Step title="Optional: GitHub integration">
|
|
Vibe Kanban uses the [GitHub CLI](https://cli.github.com/) for creating pull requests. Ensure `gh` is installed and authenticated on your system, or follow the setup prompts when creating your first pull request.
|
|
</Step>
|
|
|
|
<Step title="Optional: Set up MCP integration">
|
|
Streamline task creation with coding agents by [setting up MCP integration](/integrations/vibe-kanban-mcp-server).
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Tip>
|
|
To use a fixed port, specify the `PORT` environment variable: `PORT=8080 npx vibe-kanban`
|
|
</Tip>
|