Choose Your Interface
RoostGPT is available in four interfaces. Choose the one that best fits your workflow.
Comparison
| Feature | Web UI | CLI | IDE Plugin | API |
|---|---|---|---|---|
| Workspace Integration | Not Available | ✅ Local workspace | ✅ Local workspace | — |
| Version Control (Git) | ✅ Full support | ✅ Full support | ❌ Local only | — |
| Notifications | ✅ Real-time | ❌ None | ❌ None | — |
| License Management | ✅ UI-integrated | ✅ API / file | ✅ API / file | — |
| Webhook / Git Events | ✅ PR, push, release | ❌ None | ❌ None | — |
| User Management (RBAC) | ✅ Admin + user roles | ⚠️ Per user, local | ⚠️ Per user, local | — |
| Analytics & Reporting | ✅ Full dashboard | ❌ None | ⚠️ Basic only | — |
| Test Execution | ✅ Isolated Docker | ⚠️ Local or Docker | ⚠️ Manual deps | — |
| Ease of Use | ✅ One-click forms | ⚠️ .env config | ✅ Context menu | — |
| Test Comparison | ✅ Built-in diff view | ❌ None | ❌ None | — |
| API Server | ✅ Dedicated server | ❌ None | ❌ None | ✅ |
| History & Audit Trail | ✅ Full audit log | ⚠️ Session only | ❌ None | — |
| Team Sharing | ✅ Shared connectors | ❌ None | ❌ None | — |
| Database Persistence | ✅ Central DB | ⚠️ Local only | ⚠️ Local only | — |
| Stand-alone Deploy | ❌ Needs server | ✅ Yes | ✅ Yes | — |
| Deployment Target | Cloud / On-Prem | Linux, Windows, macOS | VS Code Marketplace | Programmatic |
Legend: ✅ Full ⚠️ Partial ❌ Not available
Web Interface (UI)
Best for: Teams that need centralized management, shared connectors, dashboards, and automated event-driven test generation via webhooks.
- Full role-based access control (admin and user views)
- Webhook support — triggers tests automatically on push, PR, or release events
- Built-in test comparison view and analytics dashboard
- Centralized connector storage (Git tokens, AI credentials)
- Available as cloud hosted or self-hosted on-prem
Get started: Self-Hosted Ubuntu or contact roost.ai for cloud access.
CLI (Command Line Interface)
Best for: Developers who prefer terminal-based workflows and want to generate tests locally or in CI/CD pipelines.
- Runs on Linux, Windows, and macOS
- Configures via
.envfiles - Supports all test types: unit, functional, API spec, integration
- Can run in local mode (no Git) or Git mode (creates PRs)
- Stand-alone — no API server or hosted instance needed
Get started: CLI Guide
IDE Plugin
Best for: Individual developers who want to generate tests directly from their editor without switching context.
- VS Code — Available on the VS Code Marketplace
- Right-click on any file → "Generate Test using RoostGPT"
- Code-lens integration — action buttons appear above Package, Class, and Function declarations
- Generated tests are placed in the standard test folder, preserving your package structure
Get started: VS Code Extension Guide
API
Best for: Automated pipelines and CI/CD integrations that call RoostGPT programmatically.
- Exposed by the hosted Web UI / API server
- Enables CI/CD tools to trigger test generation and retrieve results
- Contact support@roost.ai for API access and documentation