Getting started

Getman is a local-first API client. You use it to send requests, keep environments and auth in one place, write tests, and run collections, much like Postman. It is different in one way that matters for teams: a project lives in a folder of YAML files, so it can sit in your Git repository next to the code it calls.

Getman has no account, no server and no subscription. “No account, no sync, no telemetry” is the promise on the Welcome screen, and it holds: everything stays on your computer until you choose to commit, push or write to a folder.

What you need

• Getman 0.1.2 or later for macOS 10.13 or newer, or Windows 10 or 11 (x64) with WebView2.
• Git, if you want to share a project through a repository.
• Node.js 20 or later, only if you want the command line or a coding agent.

Your first request

1. Open Getman and choose New project… from the title bar menu, or Start an empty project on the Welcome screen.
2. Name the project. Getman creates it and opens the request workspace.
3. Choose New request (⌘N on macOS, Ctrl+N elsewhere), and enter a URL such as https://httpbin.org/get.
4. Press Send or ⌘↵.

The response pane shows the status, headers and body. Nothing else is needed to try the app.

Set up a real project

Most work starts with an environment. Each environment holds variables such as the base URL and a login, so the same request can run against a local server, a staging server or production.

1. Open Environments from the rail and add one for your local API.
2. Add a variable such as base_url and point it at your server.
3. Use the variable in your request URL: {{base_url}}/orders/:id.
4. Pick the environment from the environment menu at the top right. The status bar shows the host it targets.

Secret values, such as passwords and tokens, are masked and never written to a file that Git sees. Requests and Auth explain how to use them.

Where to go next

• Installation covers the desktop app, the command line and the team workspace.
• Requests covers request bodies, tabs and code generation.
• Team workflow shows how a backend change reaches the web team as a change package.
• Troubleshooting lists common errors and their fixes.

If you prefer to watch first, chapter 1 of the onboarding video covers installing Getman and opening the team workspace.