Home - amitsri/rostyman-releases GitHub Wiki

Rostyman Documentation

Rostyman is a local-first, privacy-focused desktop API client that runs entirely on your machine with no account required.

Quick Start

  1. Download the latest installer
  2. Install and launch โ€” no sign-up needed
  3. Create a collection and start sending requests

Features

  • Getting Started โ€” Install, first launch, and your first request
  • Workspace Management โ€” Create, switch, configure, export, and import workspaces
  • Workspaces โ€” Reference guide: workspace settings, proxy, tab persistence, and data isolation
  • Databases โ€” Connect to PostgreSQL, MySQL, SQLite, MongoDB, Redis and more; query, browse, and verify data
  • Visual Workflows โ€” Build multi-step API automation with retry, assertions, error handling, and run history
  • Collections & Requests โ€” Organize and send API requests
  • Binary Response Viewer โ€” Automatic rendering of images, video, audio, PDF, CSV, and SVG responses
  • Update Manager โ€” Automatic background updates, manual checks, and release history
  • AI Assistant โ€” Built-in AI for generating and explaining requests
  • Scripting โ€” Pre-request and test scripts using the rm.* API
  • Mock Server โ€” Local mock servers with dynamic routes and variables
  • Cloud Storage โ€” Share collections via Google Drive or Dropbox
  • Source Watching โ€” Keep collections in sync with local files or URLs
  • Notifications โ€” In-app notification center and alert types
  • Data Management โ€” Backup, restore, reset, and custom data location
  • Git Sync โ€” Version-control your collections with Git
  • Themes & Appearance โ€” 20 built-in themes and custom theme editor
  • Keyboard Shortcuts โ€” Complete shortcut reference

Protocols

Protocols

Protocol Status
HTTP/HTTPS Full support
GraphQL Full support
gRPC Full support (Unary, Server/Client/Bidi streaming)
WebSocket Full support
Socket.IO Full support (Emit, Events, Auth)
MQTT Full support (Publish, Subscribe, QoS 0/1/2, Retain)
SSE Full support (Server-Sent Events)
MCP Full support (Server + Client)

MCP โ€” AI Agent Integration

Rostyman includes a built-in MCP (Model Context Protocol) server that lets AI tools interact with your collections:

  • 18 tools for reading, executing, and creating API resources
  • Works with Claude Desktop, Claude Code, Cursor, Windsurf, VS Code
  • TLS/HTTPS support via mkcert for secure connections
  • Tunnel support (ngrok, cloudflared) for remote AI agent access
  • Connected clients tracking with disconnect capability
  • Request-level logging with tool call timing

What's New in beta.16

Database clients (headline) โ€” Rostyman is now also a database client. Eight drivers (SQLite, PostgreSQL, MySQL, MariaDB, Microsoft SQL Server, MongoDB, Redis, CockroachDB) with a redesigned connection wizard, schema browser, Monaco-based query editor with schema-aware autocomplete, browse mode with multi-column sort and inline editing, EXPLAIN visualizer, and per-driver brand icons in the sidebar.

ER Diagram โ€” visual entity-relationship diagram with auto-detected foreign keys, drag-to-rearrange tables (positions persist across restarts), high-resolution PNG export, true vector PDF export, and shareable layout JSON export/import.

AI Database Tools โ€” natural-language query assistant, AI schema analysis, and AI-generated stored procedures / functions / triggers / views.

Generate CRUD API Collection โ€” one click in the database panel toolbar creates a full collection of HTTP requests from your schema (List / Get by ID / Create / Update / Delete per table).

Query History & Saved Queries โ€” every query auto-saved per connection; save important queries with name, description, tags, and folders.

MongoDB document cards & Redis key browser โ€” type-aware native views.

DB Projects โ€” three-level hierarchy (Project โ†’ Group โ†’ Connection), drag-drop between groups, redesigned Assign-to-Group dialog with inline + New Group.

AI Tool-Use beyond databases โ€” the AI assistant can now create collections, folders, requests, and full visual workflows directly from chat.

Convert WEBM Recordings to MP4 โ€” quality / resolution / audio presets, system FFmpeg detection, surfaced FFmpeg errors on failure.

Universal Ctrl+S Save โ€” every protocol tab now saves on Ctrl+S.

Sidebar More popup โ€” bottom rail consolidated to More ยท Trash ยท Settings; Themes / Languages / Git / AI / Plugins / Cookies grouped in a flyout. Theme Manager and Language Manager now reachable from the UI.

File Sharing โ€” device-global โ€” devices, groups, and messages follow you across workspace switches.

Themed in-app dialogs everywhere; live font changes without restart.

Performance โ€” renderer bundle 5 MB โ†’ 1.6 MB; bulk schema introspection (no more N+1 for PostgreSQL/MySQL/MSSQL); Monaco tab-open lag fixed.

Security hardening โ€” git command-injection eliminated, updater host allowlist, scheme allowlist on shell open, MCP CSP headers, analytics secrets redactor.

Internationalisation โ€” all 18 languages now in full key parity at 3,529 strings; major translation pass across 17 non-English languages (295โ€“422 strings translated each).

See the full release notes for details.

Cloud Sharing

Share collections with teammates via Google Drive or Dropbox:

  • Upload and generate shareable links
  • Publish updates to keep the shared file current
  • Automatic link validation on startup
  • Deleted shares go to Trash for recovery

See Cloud Storage for details.

Support