User Manual

1. Installing Reqmark

Download the Reqmark build for your operating system and install it using the normal installer for that platform.

macOS

1. Open the Reqmark .dmg file.
2. Drag Reqmark into Applications.
3. Open Applications → Reqmark.
4. If macOS asks you to confirm the application, review the publisher/source information and continue if you trust the build.

Windows

1. Open the Reqmark installer.
2. Follow the installation wizard.
3. Launch Reqmark from the Start menu or desktop shortcut.

Linux

Use the package supplied for your distribution, or launch the AppImage if that is the build you received. The packaged project supports DEB, RPM, and AppImage builds.

2. Your First Launch

When Reqmark opens, you will see the main workspace window. If no workspace is currently open, the welcome screen lets you open a workspace or create a new one.

Reqmark remembers the last workspace and attempts to restore it the next time you launch the application.

The main window

The application is divided into four practical areas:

3. Create or Open a Workspace

A workspace is simply a folder on your computer containing your API documentation, request files, and related project files.

Create a new workspace

1. Click New Workspace.
2. Choose where the workspace should be created.
3. Enter the workspace name.
4. Confirm creation.

Reqmark opens the new folder automatically.

Open an existing workspace

1. Click Open Workspace or Open Folder.
2. Select the folder containing your API project.
3. Reqmark scans the folder and displays supported files in the sidebar.

You can use an existing Git repository as a Reqmark workspace. Reqmark does not require a special folder format.

4. Understanding the Sidebar

The left-hand sidebar is the Explorer. It displays folders and supported files from the current workspace.

Reqmark currently shows:

• .rqm — executable API documents
• .md — Markdown documents
• .env — environment/configuration files
• .json — JSON files
• .yaml / .yml — YAML files

Create a request file

Use the + button in the Explorer and enter a filename such as users.rqm. If you omit the extension when creating a file, Reqmark adds .rqm automatically.

Refresh

Use the ↺ Refresh button when files have been created or changed outside Reqmark and you want the sidebar to rescan the workspace.

5. Working With Tabs

Files you open appear as tabs above the editor.

• Click a tab to switch files.
• Click × to close a tab.
• A small dot indicates unsaved changes.
• Hover over a tab to see its file path.

Reqmark does not automatically save every keystroke. Save important changes before closing the application or switching to another tool.

6. Your First Reqmark Document

A .rqm file combines normal Markdown with executable request blocks.

# Users API

This endpoint returns a user.

<!-- rqm:block id="get-user" name="Get User" -->
```rqm
GET https://api.example.com/users/123
Accept: application/json
```

The text above the request is ordinary documentation. The fenced block is executable.

Supported methods

GET · POST · PUT · PATCH · DELETE · HEAD · OPTIONS

7. Adding Headers

Headers go underneath the request URL, one per line.

```rqm
GET https://api.example.com/profile
Authorization: Bearer YOUR_TOKEN
Accept: application/json
X-Client: Reqmark
```

Reqmark sends these headers with the request.

8. Adding a Request Body

For JSON APIs, use Content-Type: application/json and put the JSON body after a blank line.

```rqm
POST https://api.example.com/orders
Content-Type: application/json
Accept: application/json

{
  "productId": 123,
  "quantity": 2
}
```

Reqmark attempts to parse JSON request bodies before sending them. If the body is not valid JSON, it is sent as text.

9. Running a Request

Run one request

Click the ▶ Run button associated with the request block.

⌘+Enter   macOS   ·   Ctrl+Enter   Windows/Linux

Run every request

Click ▶ Run All in the toolbar at the top of the .rqm editor. Reqmark runs requests in document order.

10. Reading the Response

After a request finishes, the Response panel displays the result.

Body

Displays the response returned by the server. JSON responses are formatted for easier reading; other response formats are displayed as text.

Headers

Lists response headers such as Content-Type, caching information, authentication-related headers, rate-limit information, and server metadata.

Info

Shows HTTP status, duration, response size, and timestamp.

A network or execution failure is displayed as ERR instead of an HTTP status.

11. Saving Your Work

When you edit a file, its tab shows a dirty indicator.

Save with Cmd + S on macOS or Ctrl + S on Windows/Linux. You can also use the save control in the .rqm editor toolbar.

12. Git Workspaces

Reqmark is designed to work naturally with Git-based projects. If the workspace is already a Git repository, the application can display Git information including the current branch and changed/untracked files.

Your API documentation and executable requests can live beside the rest of your source code and be versioned together.

Reqmark does not replace Git itself. Continue using your normal Git client or command line for remote operations such as push, pull, merge, and pull requests.

13. Complete Example

Use this small document as a model:

# Demo API

A simple collection of requests for development and testing.

## Get a post

<!-- rqm:block id="get-post" name="Get Post" -->
```rqm
GET https://jsonplaceholder.typicode.com/posts/1
Accept: application/json
```

## Create a post

<!-- rqm:block id="create-post" name="Create Post" -->
```rqm
POST https://jsonplaceholder.typicode.com/posts
Content-Type: application/json
Accept: application/json

{
  "title": "Hello from Reqmark",
  "body": "Markdown becomes executable API documentation.",
  "userId": 1
}
```

Open the document, run either request, and inspect the response in the Response panel.

14. Troubleshooting

Reqmark will not open

Restart the application and try again. If the problem continues, reinstall the build you received. If your operating system blocks the application, review its security prompt and confirm that the application came from a source you trust.

My workspace is empty

Confirm that you selected the correct folder. Use Refresh if files were added externally.

My file is not visible

Reqmark's Explorer currently displays .rqm, .md, .env, .json, .yaml, and .yml files.

My request does not run

Check the method, URL, headers, blank line before the body, authentication, and network access.

401 or 403

The API is rejecting authentication or authorisation. Check the credentials and required headers.

404

Check the URL, path parameters, API version, and HTTP method.

400

Inspect the response Body and Headers for the API's explanation.

500

The request reached the server, which returned an internal error. Inspect the response and server-side logs if you control the API.

Request timeout

Reqmark gives an HTTP request up to 30 seconds. Check the URL, internet connection, VPN/proxy, firewall, and API availability.

15. Safe Use of API Credentials

Reqmark can send authentication headers because it is an API client. Treat it like any other API client.

Do: use test credentials where possible; review requests before production use; keep secrets out of committed/shared files; verify destination URLs before sending sensitive data.

Do not: commit production API keys, paste passwords into public documentation, or send confidential information to an unverified endpoint.

16. Useful Keyboard Shortcuts

Quick start

1. Install Reqmark.
2. Open a folder or create a workspace.
3. Create first-request.rqm.
4. Add a Markdown description and an executable request block.
5. Click Run.
6. Inspect the response.
7. Save with Cmd + S / Ctrl + S.
8. Commit the file to Git if the workspace is version controlled.

17. Reqmark and the CLI

Reqmark Desktop and the Reqmark CLI are separate tools that share the .rqm format. Use Desktop for interactive API development, documentation, manual execution, response inspection, and Git-native work. Use the CLI for automation, CI/CD, scripting, and headless execution.

A .rqm document can therefore serve as both human-readable API documentation and an executable request definition.

18. The Reqmark Principle

API documentation should be able to do something.

Instead of maintaining a static document in one place and a request collection somewhere else, Reqmark puts the two together.

Write. Run. Inspect. Version.

MARKDOWN. EXECUTED.