Skip to content

Quickstart

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.

Ensure you have the following prerequisites installed on your machine:

Installing Rover and getting it to work for you is straightforward, just follow the steps:

1. Installing Rover

  1. 1

    Install Rover

    Terminal window
    npm install -g @endorhq/rover@latest
  2. 2

    Check that Rover is correctly installed

    Terminal window
    rover --version
  3. 3

    Congratulations! You are a step closer to making those agents work for you

From here on you are ready to use Rover on any git project.

2. Creating your first task

  1. 1

    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:

    Terminal window
    mkdir -p ~/rover-quickstart && cd ~/rover-quickstart && git init && \
    touch README.md && git add README.md && git commit -m 'Initial commit'
  2. 2

    Ask Rover to create a fizzbuzz program

    Terminal window
    rover task -y "Create a fizzbuzz bash program as a programming example"

    Rover will automatically detect your installed AI agents and register the project.

  3. 3

    Watch the task progress

    Terminal window
    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 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.