GalleonQL Manual
Changelog

GalleonQL User Manual

This is the end-user manual for GalleonQL (a GraphQL-focused client). It covers terminology and how to use the app, and does not include developer-facing content (internal specifications or implementation steps).

(Topics are being added over time. See the table of contents below.)

Table of Contents

  1. Overview and Features — What GalleonQL is, the three areas of the window (the left panel for collections / request history / schema, request, and response), and the order to do things in
  2. What GalleonQL Is (Overview) / Installation and Launch — An overview of GalleonQL and how to install and launch it on each OS (macOS / Windows / Linux): macOS through the Mac App Store, plus how to open the unsigned Windows and Linux binaries.
  3. Key Terms — Environments (switchable, orthogonal connection profiles), collections, and queries; add Query vs. add Child; leaves and branches; environment variables ({{...}}) vs. GraphQL variables ($id); the header cascade; the HTTP timeout cascade; and the schema
  4. Importing a Schema — Importing via HTTP introspection, and importing from local files
  5. Browsing the Schema Documentation — The type catalog of an imported schema (browsing and searching types and fields)
  6. Query Builder — Building a query step by step with add Query / add Child, and switching granularity
  7. Building Queries from Plain Sentences (AI Assist) — Jev (TypeSafe's AI) chooses from your schema's candidates and suggests a query shape from a sentence. Setup (API key, connection test), reviewing suggestions, what is sent, and cost
  8. Registering and Switching Environments — Registering, editing, and switching environments (connection profiles), and configuring environment variables, authentication, headers, and HTTP timeouts
  9. Reordering and Moving — Changing the order of query fields, collections, favorites, environments, and projects (drag and drop / Option (Alt) + ↑↓ / the ⋯ menu)
  10. Renaming and Creating Folders — Renaming folders, saved queries, environments, and projects (double-click / F2 / the ⋯ menu), and creating collection folders
  11. Sending Queries and Reading Responses — Choosing the HTTP method, previewing the final headers, and the classification of results and errors (Network / Authentication / Client / Server / Partial errors)
  12. Request hooks (extract and assert) — After send: extract response values into environment variables, or declaratively assert status/body (Pro)
  13. Exporting / Importing Projects — Exporting and importing on a per-project basis, and third-party collection import (Postman v2.1 GraphQL, Pro)
  14. Plans (Free / Pro) and licenses — Free vs Pro, Pro-only features (hooks including assertions, Subscription, schema diff, third-party import), purchasing and cancelling (Mac App Store on macOS, license key on Windows / Linux)
  15. Crash Reporting — Enabling crash / error reporting and using the pre-send confirmation
  16. Usage Analytics — Enabling / disabling anonymous usage analytics (a separate consent from crash reporting)
  17. Keyboard Shortcuts — Keys for sending, switching tabs and panes, saving, and opening settings, keys that work per place, moving with Tab and the arrow keys, and changing keys on the "Shortcuts" tab in Settings
  18. Changelog — See the GitHub release notes for the changes in each version (this manual carries no body text for it, only an external link)