Getting Started - amitsri/rostyman-releases GitHub Wiki

Getting Started

Installation

Download the latest release for your platform from the Releases page. No account or sign-up required.

Windows

  1. Download Rostyman-Setup-x.x.x.exe
  2. Run the installer — it will install and launch automatically

macOS

  1. Download Rostyman-x.x.x-arm64.dmg (Apple Silicon) or Rostyman-x.x.x.dmg (Intel)
  2. Open the .dmg and drag Rostyman to Applications
  3. Important: Rostyman is not yet code-signed. On first launch macOS will block it. Run this command in Terminal to remove the quarantine flag: 
    xattr -cr /Applications/Rostyman.app
  4. Now open Rostyman from Applications normally

Linux

  1. Download Rostyman-x.x.x.AppImage
  2. Make it executable: chmod +x Rostyman-x.x.x.AppImage
  3. Run it: ./Rostyman-x.x.x.AppImage

First Launch

On first launch, Rostyman creates a local SQLite database to store all your data. Everything stays on your machine.

A welcome dialog will offer to load the demo collection — a showcase of 76 example requests covering HTTP, GraphQL, WebSocket, gRPC, Socket.IO, MQTT, MCP, and more. You can also load it later from Help > Load Demo Collection.

The default theme is Rostyman Light — you can change it in Settings > Appearance or from the theme dropdown in the title bar.

Workspaces

Rostyman organizes your work into workspaces. The default workspace is "My Workspace". You can create additional workspaces for different projects using the workspace switcher in the center of the title bar. See Workspaces for details.

Updates

Rostyman checks for updates automatically. You can also check manually in Settings > About > Updates tab, or click the version number in the title bar. The update manager lets you upgrade, downgrade, or install specific versions.

Creating Your First Request

  1. Press Ctrl+T or click + to open a new tab
  2. Enter a URL (e.g., https://jsonplaceholder.typicode.com/posts/1)
  3. Click Send or press Ctrl+Enter
  4. View the response in the bottom panel

Saving to a Collection

  1. Press Ctrl+S or click Save
  2. Create a new collection or select an existing one
  3. Choose a folder (optional)
  4. Click Save

Using the AI Assistant

  1. Press Ctrl+Alt+P (or Cmd+Opt+P on Mac) to open the AI panel
  2. Click the Settings icon and select your provider (Anthropic Claude, OpenAI, or Ollama for local)
  3. For cloud providers, add your API key in Settings > Vault first, then select it in the AI config
  4. Ask questions about APIs, generate requests, or paste a cURL command
  5. Use quick actions (Generate, Explain, Tests, Fix, Mock Data, Document, Validate Schema) for common tasks
  6. Code blocks in responses have action buttons — click to apply as body, test script, or import as request

Screenshot & Video Capture

  1. Click the Camera icon in the status bar to capture a screenshot
  2. Click the Video icon to start recording — pause/stop controls appear in the title bar
  3. Open the Media panel in the sidebar to view all captures
  4. Right-click a media item for Open, Open Folder, Share, Properties, or Delete
  5. Deleted media goes to App Trash with undo support

Screenshots are saved to ~/Pictures/Rostyman, videos to ~/Videos/Rostyman.

SSE (Server-Sent Events)

  1. Set the Accept header to text/event-stream or add "stream": true to the JSON body
  2. Click Send — Rostyman auto-detects SSE and switches to streaming mode
  3. Events appear in real-time in the event log with colored badges
  4. Supports both GET and POST methods with request body
  5. Search, expand/collapse events, and toggle JSON/Text view

System Tray

When you close Rostyman, it minimizes to the system tray instead of quitting. Click the tray icon to restore, or right-click for the menu. On Linux, if the tray is unavailable, the app quits normally.

Auto-Updates

Rostyman checks for updates automatically. When a new version is available, it downloads in the background and you'll receive a system notification. Install on next restart or check manually via Help > Check for Updates.