2dba0713c8
* Perfect! I've successfully simplified the disclaimer dialog as requested. Here's what I've accomplished: 1. **Removed checkbox requirement**: - Eliminated the `useState` for tracking acknowledgment - Removed the `Checkbox` component and its imports - Simplified the `handleAccept` function to directly resolve 2. **Simplified the language**: - Changed title from "Important Safety Warning" to "Safety Notice" - Replaced lengthy technical details with concise, clear messaging - Focused on key points: AI agents can execute code, use responsibly, keep backups 3. **Added documentation link**: - Included a clickable link to `https://www.vibekanban.com/docs` - Styled the link with appropriate hover effects 4. **Updated button behavior**: - Removed the `disabled` state since no checkbox is required - Changed button variant from "destructive" to "default" (less alarming) - Updated button text to "I Understand, Continue" - **Rust linting**: ✅ All clippy checks passed - **Frontend formatting**: ✅ Prettier formatted the disclaimer dialog - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings, nothing related to my changes The disclaimer dialog is now much more user-friendly while still maintaining important safety messaging, with users directed to the full documentation for detailed information. Perfect! I've successfully updated the disclaimer dialog to mention the `--dangerously-skip-permissions`/`--yolo` flags that Vibe Kanban runs by default, which clarifies the source of the danger. **Updated the disclaimer dialog to:** 1. **Clearly identify the source of danger**: The first paragraph now explicitly mentions that Vibe Kanban runs AI coding agents with `--dangerously-skip-permissions` / `--yolo` by default 2. **Explain the implications**: Clarifies that this gives agents "unrestricted access to execute code and run commands on your system" 3. **Maintain other improvements**: Kept the simplified language, removed checkbox, and documentation link - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ Prettier formatted the updated disclaimer dialog - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings, nothing related to my changes The disclaimer now provides much clearer information about why the software is potentially dangerous - it's specifically because Vibe Kanban runs agents with flags that bypass safety permissions by default. This gives users a better understanding of the actual risk source while maintaining the user-friendly approach. Perfect! I've successfully fixed the link visibility issue in dark mode and completed all the requested improvements to the disclaimer dialog. **Disclaimer Dialog Improvements:** 1. **✅ Removed checkbox requirement**: No more mandatory checkbox interaction 2. **✅ Simplified language**: Clear, concise messaging instead of lengthy technical details 3. **✅ Added docs link**: Points users to https://www.vibekanban.com/docs for detailed information 4. **✅ Updated button behavior**: Changed from "destructive" red button to neutral "default" styling 5. **✅ Added specific risk clarification**: Now explicitly mentions `--dangerously-skip-permissions`/`--yolo` flags as the source of danger 6. **✅ Fixed dark mode visibility**: Link now uses `text-blue-600 dark:text-blue-400` for proper visibility in both light and dark themes - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted with Prettier - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes The disclaimer dialog is now much more user-friendly while clearly communicating the specific safety risks. Users get a concise explanation of why the software is potentially dangerous (the `--yolo` flags), with a link that works in both light and dark modes for those who want detailed information. Perfect! I've successfully completed both changes: **Location**: `docs/getting-started.mdx` **Added**: New "Safety Notice" section with your exact wording: - Explains why `--dangerously-skip-permissions`/`--yolo` flags are used (autonomous operation) - Notes that each task runs in isolated git worktrees (preventing interference) - Reminds users that agents can still perform system-level actions - Advises reviewing work and keeping backups **Location**: `frontend/src/components/dialogs/global/DisclaimerDialog.tsx` **Changed**: "For detailed information about risks and best practices, visit" → "Learn more at" **Reason**: More accurate since the docs don't contain comprehensive security information - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes The security messaging is now much more accurate and helpful. Users will see the safety notice right when they're installing, and the disclaimer dialog doesn't overpromise what they'll find in the documentation. Perfect! I've successfully updated the disclaimer dialog link to point directly to the new safety section we created. **Location**: `docs/getting-started.mdx` **Added**: New "Safety Notice" section explaining: - Why `--dangerously-skip-permissions`/`--yolo` flags are used (autonomous operation) - Git worktree isolation preventing agent interference - System-level action risks and backup recommendations **Location**: `frontend/src/components/dialogs/global/DisclaimerDialog.tsx` **Changed**: - Text: "For detailed information about risks and best practices, visit" → "Learn more at" - URL: `https://www.vibekanban.com/docs` → `https://www.vibekanban.com/docs/getting-started#safety-notice` **Result**: Users now get directed to the specific safety section that actually contains relevant information about the risks we're warning them about. - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes Now when users see the disclaimer dialog and click "Learn more at", they'll be taken directly to the relevant safety information instead of just the general docs homepage. This creates a much better, more cohesive user experience! * Perfect! I've successfully changed the safety notice from `<Info>` to `<Warning>` callout, and the reviewer was absolutely right - this is much more appropriate for safety-critical information about dangerous permissions. ## ✅ Final Summary of All Changes ### Disclaimer Dialog Improvements: 1. **✅ Removed checkbox requirement**: No mandatory checkbox interaction 2. **✅ Simplified language**: Clear, concise messaging with specific mention of `--dangerously-skip-permissions`/`--yolo` flags 3. **✅ Fixed dark mode link visibility**: Uses proper color classes for both themes 4. **✅ Updated link text and target**: "Learn more at" pointing directly to `#safety-notice` section 5. **✅ Changed button styling**: From "destructive" to "default" variant ### Documentation Improvements: 6. **✅ Added Safety Notice to Getting Started**: New section explaining dangerous flags, git worktree isolation, and best practices 7. **✅ Used proper Warning callout**: Changed from `<Info>` to `<Warning>` as suggested by reviewer - much more appropriate for safety information ## ✅ Quality Checks Passed - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 97 warnings (no errors) - all existing warnings unrelated to our changes The safety messaging is now complete and properly emphasizes the importance of the information with the `<Warning>` callout, while still being informative and not overly alarming. Users get a clear understanding of the risks and protections, with direct access to the relevant safety documentation. * Clippy
72 lines
2.3 KiB
Plaintext
72 lines
2.3 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
|
|
|
|
<Info>
|
|
All supported coding agents can be used via npx without separate installation. You can find authentication instructions for each coding agent on their respective [websites](./supported-coding-agents).
|
|
</Info>
|
|
|
|
## 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="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 authentication is optional and can be configured later.
|
|
</Step>
|
|
|
|
<Step title="Create your first project">
|
|
You'll land on an empty Projects page. Click "Create your first project" to set up your initial project.
|
|
</Step>
|
|
|
|
<Step title="Add tasks">
|
|
Start tracking your work by [creating tasks](/core-features/creating-tasks) within your project.
|
|
</Step>
|
|
|
|
<Step title="Optional: Configure GitHub integration">
|
|
Connect to GitHub in [Settings](/configuration-customisation/global-settings) to enable branch management and pull request creation.
|
|
</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>
|