Documentation
Everything from your first request to a team handoff through Git and MCP.
Get started
Everyday work
- RequestsBuild and send HTTP requests, choose a body mode, read the response, and generate code for the web app.
- AuthSet authentication once for a project and let requests inherit it, add OAuth 2.0 and token flows, and keep secrets out of Git.
- TestingCheck responses with no-code assertions, copy values between requests with extractors, write scripts, and run whole collections.
- ContractsExport a project as an OpenAPI 3.1 contract, compare two contracts for breaking changes, and design an API in the app.
Team and Git
- Git and collaborationWhat Getman keeps in the getman/ folder, what it syncs on its own, and which Git actions only happen when you click.
- Change packagesWhat a change package contains, how its states and verification labels work, and the rules that keep it safe in Git.
- Team workflowHow a backend change reaches the web team through Git, from the first API edit to an integration that is verified.
CLI and agents
- Command lineThe getman command, its run, contract, change, mock and mcp commands, the options, the JSON output and the exit codes.
- Connect a coding agent (MCP)Connect Claude Code or another MCP client to a Getman workspace, set the secrets, approve production requests and use the read and write tools.
Reference
- TroubleshootingFixes for the most common problems with the desktop app, the command line, Git sync and coding agents.
- SecurityHow Getman stores secrets, what it sends over the network, how scripts and responses are isolated, and the known defaults.
- Keyboard shortcutsEvery keyboard shortcut in the Getman desktop app, grouped by what it does, with the conditions under which each one works.