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.
130 lines
4.8 KiB
Plaintext
130 lines
4.8 KiB
Plaintext
---
|
|
title: "Global Settings"
|
|
description: "Configure application-wide settings including themes, agents, and more"
|
|
sidebarTitle: "Settings"
|
|
---
|
|
|
|
You can configure application-wide settings via the **Settings** page. To access it, click the ⚙️ icon in the sidebar or select "Settings" from the top-right menu.
|
|
|
|
<Frame>
|
|
<img src="/images/vk-settings.png" alt="Vibe Kanban global settings page showing theme options, agent configuration, and settings" />
|
|
</Frame>
|
|
|
|
## Themes
|
|
|
|
Switch between light and dark themes to suit your preference.
|
|
|
|
## Default Agent Configuration
|
|
|
|
Choose the default agent and variant for new task attempts. This profile is pre-selected when creating new task attempts and follow-ups.
|
|
|
|
1. **Select an agent** (e.g., Claude Code, Gemini CLI, Codex)
|
|
2. **Choose a variant** if available (e.g., Default, Plan, Router)
|
|
|
|
<Tip>
|
|
You can override the default agent configuration per attempt in the create attempt dialog.
|
|
</Tip>
|
|
|
|
## Editor Integration
|
|
|
|
Configure integration with your preferred code editor for a seamless development workflow.
|
|
|
|
### Selecting Your Editor
|
|
|
|
Choose from various supported editors:
|
|
- **VS Code** - Microsoft's popular code editor
|
|
- **Cursor** - VSCode fork with AI-native features
|
|
- **Windsurf** - VSCode fork optimized for collaborative development
|
|
- **Neovim**, **Emacs**, **Sublime Text** - Other popular editors
|
|
- **Custom** - Use a custom shell command
|
|
|
|
### Remote SSH Configuration
|
|
|
|
<Frame>
|
|
<img src="/images/vk-editor-ssh.png" alt="Vibe Kanban settings editor section showing ssh configuration options." />
|
|
</Frame>
|
|
|
|
When running Vibe Kanban on a remote server (e.g., accessed via Cloudflare tunnel, ngrok, or as a systemctl service), you can configure VSCode-based editors to open projects via SSH instead of assuming localhost.
|
|
|
|
This feature is available for **VS Code**, **Cursor**, and **Windsurf** editors.
|
|
|
|
#### When to Use Remote SSH
|
|
|
|
Enable remote SSH configuration when:
|
|
- Vibe Kanban runs on a remote server (VPS, cloud instance, etc.)
|
|
- You access the web UI through a tunnel or reverse proxy
|
|
- Your code files are on a different machine than your browser
|
|
- You want your local editor to connect to the remote server via SSH
|
|
|
|
#### Configuration Fields
|
|
|
|
1. **Remote SSH Host** (Optional)
|
|
- The hostname or IP address of your remote server
|
|
- Examples: `example.com`, `192.168.1.100`, `my-server`
|
|
- Must be accessible via SSH from your local machine
|
|
|
|
2. **Remote SSH User** (Optional)
|
|
- The SSH username for connecting to the remote server
|
|
- If not specified, SSH will use your default user or SSH config
|
|
|
|
#### How It Works
|
|
|
|
When remote SSH is configured, clicking "Open in VSCode" (or Cursor/Windsurf):
|
|
1. Generates a special protocol URL like: `vscode://vscode-remote/ssh-remote+user@host/path/to/project`
|
|
2. Opens in your default browser, which launches your local editor
|
|
3. Your editor connects to the remote server via SSH
|
|
4. The project or task worktree opens in the remote context
|
|
|
|
This works for both project-level and task worktree opening.
|
|
|
|
#### Prerequisites
|
|
|
|
- SSH access configured between your local machine and remote server
|
|
- SSH keys or credentials set up (no password prompts)
|
|
- VSCode Remote-SSH extension installed (or equivalent for Cursor/Windsurf)
|
|
- The remote server path must be accessible via SSH
|
|
|
|
<Tip>
|
|
Test your SSH connection first with `ssh user@host` to ensure it works without prompting for passwords.
|
|
</Tip>
|
|
|
|
## Git Configuration
|
|
|
|
Configure git branch naming preferences.
|
|
|
|
### Branch Prefix
|
|
|
|
Set a prefix for auto-generated branch names (e.g., `vk` results in `vk/task-name`). Leave empty for no prefix.
|
|
|
|
## Notifications
|
|
|
|
Toggle sound effects and push notifications to stay informed about task status changes.
|
|
|
|
## Telemetry
|
|
|
|
Enable or disable telemetry data collection to help improve Vibe Kanban.
|
|
|
|
## Task Tags
|
|
|
|
Manage global task tags to accelerate task creation across all projects. Task tags allow you to define reusable text snippets that can be inserted into task descriptions using @mentions.
|
|
|
|
<Card title="Learn more about task tags" icon="tag" href="/configuration-customisation/creating-task-tags">
|
|
Complete guide to creating and managing task tags
|
|
</Card>
|
|
|
|
## Agent Settings (Profiles & Variants)
|
|
|
|
Define and customise agent variants under **Settings → Agents**. Variants let you maintain multiple configurations for the same agent (for example, a Claude Code "PLAN" variant).
|
|
|
|
<Card title="Agent Profiles & Variants" icon="robot" href="/configuration-customisation/agent-configurations">
|
|
Detailed guide with examples for configuring agent variants
|
|
</Card>
|
|
|
|
## Safety & Disclaimers
|
|
|
|
Manage acknowledgments and reset options for onboarding, safety disclaimers, and telemetry notices.
|
|
|
|
- **Onboarding**: Reset the onboarding process to rerun the initial setup.
|
|
- **Safety Disclaimer**: Reset or review the safety disclaimer prompt.
|
|
- **Telemetry Notice**: Reset or review the telemetry data collection acknowledgment.
|