​
🔥 Quick Start

​
Prerequisites

  • Python 3.10+
  • An API key for an LLM provider (e.g., OpenAI, Google, Anthropic).

​
Installation

  1. Clone the repository: 
    git clone https://github.com/qualifire-dev/rogue.git
cd rogue
  2. Install dependencies: If you are using uv: 
    uv sync
    Or, if you are using pip: 
    pip install -e .
  3. Set up your environment variables (optional): Create a .env file in the root directory and add your API keys. Rogue uses LiteLLM, so you can set keys for various providers. 
    OPENAI_API_KEY="sk-..."
ANTHROPIC_API_KEY="sk-..."
GOOGLE_API_KEY="..."

​
Running Rogue

You can run Rogue in two ways:
  1. Web UI: Launch the Gradio web UI with the following command:
    • Using uv: 
      uv run -m rogue
    • Using pip: 
      python -m rogue
      Then, navigate to the URL displayed in your terminal (usually http://127.0.0.1:7860).
  2. CLI: Run evaluations directly from the command line. For more details, see the CLI documentation. 
    uv run -m rogue cli [OPTIONS]

​
Example: Testing the T-Shirt Store Agent

This repository includes a simple example agent that sells T-shirts. You can use it to see Rogue in action.
  1. Install example dependencies:
    • Using uv: 
      uv sync --group examples
    • Using pip: 
      pip install -e .[examples]
  2. Start the example agent server in a separate terminal:
    • Using uv: 
      uv run examples/tshirt_store_agent
    • Using pip: 
      python -m examples/tshirt_store_agent
    This will start the agent on http://localhost:10001.
  3. Configure Rogue in the UI to point to the example agent:
    • Agent URL: http://localhost:10001
    • Authentication: no-auth
  4. Run the evaluation and watch Rogue test the T-Shirt agent’s policies!