Getting Started: The Remoroo CLI Workflow
The Remoroo CLI is your terminal-based command center for autonomous software engineering. It allows you to dispatch agents to fix bugs, refactor code, and optimize local repositories directly from your command line.
1. Installation
Remoroo is distributed as a Python package. Ensure you have Python 3.10+ installed.
pip install remoroo
Verify the installation by checking the help command:
remoroo --help
2. Authentication
To use Remoroo (even for local runs if they use our hosted intelligence models), you need to authenticate.
remoroo login
This will open your browser to authorize the device. Once confirmed, your API key will be securely stored in ~/.config/remoroo/credentials.
To verify your session:
remoroo whoami
3. Running Your First Experiment
Let's run a simple "Hello World" fix to see the engine in action.
Setup
Create a file named greeter.py with an intentional bug:
# greeter.py
def greet():
return "Hello Mars" # Bug: Should be "Hello World"
if __name__ == "__main__":
print(greet())
Dispatch the Agent
Run the remoroo command to fix this file. We'll use the --local flag to run the execution engine on your machine (requires Docker).
remoroo run --local \
--goal "Fix the greet function to return 'Hello World'" \
--metrics "output == 'Hello World'"
What happens next?
- Plan: The agent analyzes
greeter.pyand proposes a plan. - Patch: It applies a patch to change "Hello Mars" to "Hello World".
- Verify: It runs the code and checks if the output matches your metric.
- Result: If the metric passes, the run is marked as SUCCESS.
4. Common Commands
| Command | Description |
|---|---|
remoroo login | Authenticate your CLI client. |
remoroo run --local | Run an experiment using your local Docker engine (Free Tier). |
remoroo run --remote | Dispatch execution to Remoroo's secure cloud sandbox (Pro/Enterprise). |
remoroo whoami | Check current user and plan status. |
remoroo logout | Clear local credentials. |
5. Tips for Success
- Be Specific: The
goalshould clearly state what needs to change. - Define Metrics: Clear success criteria (like unit tests or output checks) help the agent verify its own work.
- Version Control: Always run Remoroo in a git repository. The agent makes changes to your files, so being able to
git difforgit checkout .is essential.