Reqbeam Documentation

Welcome to the Reqbeam documentation. Reqbeam is a modern, open-source API testing and development platform that provides both a web interface and a powerful command-line tool.

What is Reqbeam?

Reqbeam is a comprehensive API testing platform built with Next.js 15, TypeScript, Prisma, and Tailwind CSS. It provides everything you need to test, organize, and manage your APIs.

Quick Links

Getting Started

• Installation Guide
• Quick Start Guide
• Setup Instructions

Core Features

• Web Interface Documentation
• CLI Tool Documentation
• Workspace Management
• Authorization System

Advanced Topics

• Database Setup
• Google OAuth Setup
• Docker Deployment
• Keyboard Shortcuts

Documentation Structure

Getting Started

• Installation - How to install and set up Reqbeam
• Quick Start - Get up and running in minutes
• Setup Guide - Detailed setup instructions

Web Interface

• Workspace Feature - Managing workspaces
• Authorization System - Authentication methods
• Keyboard Shortcuts - Power user features
• Workspace Quick Start - Workspace basics
• Workspace URL Routing - URL structure

CLI Tool

• CLI Authentication - CLI authentication guide
• CLI Environment Management - Managing environments
• CLI Examples - Usage examples
• CLI History - Execution history
• CLI Sync - Web UI synchronization
• CLI Commands Verification - Command reference

Configuration

• Database Migration - Database setup
• Google OAuth Setup - OAuth configuration
• Google OAuth Implementation - Implementation details
• Auth Server - Authentication server setup
• Prisma Setup - Prisma configuration

Installation

For detailed installation instructions, see the Installation Guide.

Quick Start

For step-by-step instructions, see the Quick Start Guide.

Features

Web Interface

• HTTP request builder with all methods
• Query parameters and headers management
• Multiple authentication types
• Response viewer with syntax highlighting
• Request history tracking
• Collections organization
• Environment variables
• Workspace management
• Mock servers

CLI Tool

• Workspace management
• Environment management
• Request and collection management
• Request execution
• Test automation
• Logging and monitoring
• Real-time web UI sync

Support

• Documentation: Browse this documentation site
• GitHub Issues: Report bugs or request features
• GitHub Discussions: Ask questions and share ideas

Contributing

We welcome contributions! See the Contributing Guide for details.

Last Updated: [Current Date]
Version: 1.0.0