diff --git a/src/content/docs/rover/intro/migrate-v2.mdx b/src/content/docs/rover/intro/migrate-v2.mdx new file mode 100644 index 0000000..e898de2 --- /dev/null +++ b/src/content/docs/rover/intro/migrate-v2.mdx @@ -0,0 +1,100 @@ +--- +title: Migrating to Rover v2 +description: What's new in Rover v2 and how to migrate from v1 +sidebar: + order: 3 +--- + +import { Aside, CardGrid, LinkCard } from '@astrojs/starlight/components'; + +Rover v2 introduces a centralized architecture for better multi-project support. The good news: **no action is required from users**. Your existing projects will continue to work as before. + +This guide explains what changed and optional cleanup steps you may want to take. + +## What Changed + +### Global Store + +Rover now uses a centralized [Global Store](/rover/advanced/global-store) to manage configuration and tasks across all your projects. + +| Platform | Location | +|----------|----------| +| macOS/Linux | `~/.rover/` | +| Windows | `%APPDATA%\Rover\` | + +The Global Store contains: +- **Configuration** (`config/rover.json`): User preferences, [telemetry settings](/rover/config/telemetry), and project registry +- **Task data** (`data/projects/`): Centralized storage for all task data +- **Cache** (`cache/`): Temporary files + +### Project Configuration is Optional + +The [`rover.json`](/rover/config/project-config) file at your project root is now **optional**. Rover can detect your project's languages and package managers automatically when you run `rover init`. + +If you already have a `rover.json`, it will continue to work and be respected. + +## Task Storage + +Rover v2 changes where new tasks are stored while maintaining full compatibility with existing tasks. + +### Existing Tasks + +Tasks created with v1 remain in your project's `.rover/tasks/` directory. Rover will continue to read and manage them from this location. You don't need to move or migrate them. + +### New Tasks + +New tasks are created in the [Global Store](/rover/advanced/global-store) at: +- **macOS/Linux**: `~/.rover/data/projects//tasks/` +- **Windows**: `%APPDATA%\Rover\data\projects\\tasks\` + +### Cleaning Up Old Tasks + +After you've merged or pushed your v1 tasks, you can delete them using the [`rover delete`](/rover/reference/cli-reference#delete) command: + +```sh +# Delete specific tasks by ID +rover delete 1 2 3 + +# Check task status before deleting +rover list +``` + + + +## Automatic Migration + +Rover handles migration automatically: + +- **Task IDs**: Your existing task counter is preserved and migrated to the Global Store +- **Configuration**: Your [`rover.json`](/rover/config/project-config) settings are respected (if present) +- **Telemetry**: Your [telemetry preferences](/rover/config/telemetry) are migrated from the legacy location + +## Summary + +| Aspect | v1 | v2 | +|--------|----|----| +| Task storage | `.rover/tasks/` in project | [Global Store](/rover/advanced/global-store) (with legacy support) | +| Configuration | `rover.json` required | [`rover.json`](/rover/config/project-config) optional | +| Multi-project | Isolated | Centralized registry | + +## Verify Your Setup + +After updating Rover, verify everything works: + +```sh +# Check version +rover --version + +# List your tasks (should show existing tasks) +rover list +``` + +## Next Steps + + + + + + diff --git a/src/content/docs/rover/intro/overview.mdx b/src/content/docs/rover/intro/overview.mdx index b849a19..15abc41 100644 --- a/src/content/docs/rover/intro/overview.mdx +++ b/src/content/docs/rover/intro/overview.mdx @@ -23,7 +23,7 @@ Rover will prepare an isolated environment for each task and ensure the agents c - **Docker** or **Podman** - **Supported AI Agent** ([Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview#get-started-in-30-seconds), [Codex](https://github.com/openai/codex?tab=readme-ov-file#installing-and-running-codex-cli), [Gemini](https://github.com/google-gemini/gemini-cli?tab=readme-ov-file#quick-install), [Cursor](https://cursor.com/cli) or [Qwen](https://github.com/QwenLM/qwen-code?tab=readme-ov-file#installation)) - + Install Rover @@ -41,20 +41,13 @@ Rover will prepare an isolated environment for each task and ensure the agents c - Visit your git tracked project + Navigate to your git tracked project ```sh cd ~/my-project ``` - Initialize Rover in the project - - ```sh - rover init - ``` - - Create your first task ```sh diff --git a/src/content/docs/rover/intro/quickstart.mdx b/src/content/docs/rover/intro/quickstart.mdx index a4b2a2e..f46064d 100644 --- a/src/content/docs/rover/intro/quickstart.mdx +++ b/src/content/docs/rover/intro/quickstart.mdx @@ -7,8 +7,7 @@ sidebar: import StepList from '../../../../components/StepList.svelte'; import StepItem from '../../../../components/StepItem.svelte'; -import { Card, CardGrid } from '@astrojs/starlight/components'; -import { LinkCard, Tabs, TabItem } from '@astrojs/starlight/components'; +import { CardGrid, LinkCard, Tabs, TabItem } from '@astrojs/starlight/components'; This quickstart guide will help you install Rover and get it running in your system. By the end of this guide, you'll have Rover set up and be able to create your first task with an AI coding agent. @@ -50,16 +49,15 @@ Installing Rover and getting it to work for you is straightforward, just follow ``` - Congratulations!, you are a step closer to making those agents work for you + Congratulations! You are a step closer to making those agents work for you -From here on you are ready to enable Rover on a project that you have -on your filesystem. +From here on you are ready to use Rover on any git project. - + - Navigate to a project in which you want to enable Rover. This project needs to have git initialized, and at least one commit has to exist in its history. + Navigate to a git project. The project needs to have git initialized and at least one commit in its history. You can use the following commands to create a sample project: ```sh @@ -67,45 +65,27 @@ on your filesystem. touch README.md && git add README.md && git commit -m 'Initial commit' ``` - - Init Rover - - ```sh - rover init - ``` - - Rover will detect all supported installed agents in your system. You can init Rover in as many projects as you wish. - - - Now you are ready to ask Rover its first task! - - - - - - Navigate to the project in which you enabled Rover - - ```sh - cd ~/rover-quickstart - ``` - Ask Rover to create a [fizzbuzz](https://en.wikipedia.org/wiki/Fizz_buzz) program ```sh rover task -y "Create a fizzbuzz bash program as a programming example" ``` + + Rover will automatically detect your installed AI agents and register the project. - You can now read the Common Workflows document to see what are the common ways in which you can interact with Rover, but in the meantime you can watch the task list progress. + Watch the task progress ```sh rover list -w ``` + + You can also check the Common Workflows section below to see how you can interact with Rover. -Congratulations! **You have successfully installed Rover, initialized it in a project, and created your first task**. From here, you can explore more advanced features and workflows to make the most out of Rover and AI coding agents. +Congratulations! **You have successfully installed Rover and created your first task**. From here, you can explore more advanced features and workflows to make the most out of Rover and AI coding agents. ## Common Workflows