Getman
العربيةDownload

Installation

Install the Getman desktop app on macOS or Windows, add the command line tool, and open the team workspace.

Watch this in the tutorial: Install Getman and open the team workspace (1:03)

Getman ships as a desktop app for macOS and Windows, and as a command line tool that the app installs for you. You need the app for daily work and the command line only if you want to run requests from a terminal or let a coding agent use Getman.

Requirements

Item macOS Windows
OS 10.13 or newer, universal build 10 or 11, x64
Installer .dmg .msi or .exe
Extra software None WebView2
Git Optional, for team sync Optional, for team sync
Node.js 20 or newer, for the command line only 20 or newer, for the command line only

Install on macOS

  1. Download the build for your system from the team’s GitHub release, or from the artifacts of the latest build workflow run.
  2. Open the .dmg and drag Getman to Applications.
  3. Open Getman the first time with right-click → Open. The build is not signed yet, so macOS asks once.

Install on Windows

  1. Download the .msi or .exe installer.
  2. Run it and follow the prompts.

Install the command line tool

The command line tool is optional. It is the same engine as the app, and it lets terminals and agents run requests.

  1. Open Project settings and choose Command line & agents.
  2. Choose Install command-line tool.
  3. Check that the launcher is on your PATH.

Getman writes a getman launcher to ~/.local/bin, or to %LOCALAPPDATA%\Getman\bin on Windows. If Getman says that folder is not on your PATH, add it to your shell profile or system settings. It also warns if Node.js is missing.

To check the tool, run:

getman help

Open a team workspace

Open a team workspace from a fresh clone in one step, from the Open a team workspace card on the Welcome screen or the title bar menu item Open team workspace….

Or link a clone through the project settings:

  1. Clone the repository as usual.
  2. Create or open a project in Getman, then go to Project settings → Team sync.
  3. Choose Choose folder and pick the getman folder in your clone.
  4. Choose Load from folder. If Getman asks which version to keep, pick the one you mean.

The folder holds the project, its environments, requests, the contract and the change packages. Secret values are never in the folder, so fill them in once under Environments. Getman stores them in your system keychain. Git and collaboration explains what Getman syncs and what Git does.

Check the install

  1. Open a project and send any request.
  2. Run getman help in a terminal.
  3. Confirm the environment menu shows the environment you expect.

If something fails, see Troubleshooting.