File formats

.restorm — the project

The project file. YAML by default; the json and json5 formats are also supported.

It holds the whole tree — folders, environment folders, requests, scenarios — the environments and their variables, the custom value lists, the enumerations, the tags and their colours, the API documentation, the “project”-scoped quick settings, a project identifier and a format version.

Commit it. See .restorm projects and files.

Folder mode

The same content, spread across the disk:

File	Role
restorm.conf	Minimal configuration at the root: format: yaml | json | json5
index.yaml (or .yml, .json, .json5)	One index per directory
<index> - <name>/	The folders, prefixed with a zero-padded index

Characters the file systems forbid (<>:"/\|?*) are replaced with _, and names are truncated to 100 characters.

Commit it.

.restorm/settings.json

The workspace settings, in a sub-folder of the project’s directory. A sparse JSON file: only the overridden keys appear in it.

Commit it if you want to impose settings on the team.

<project>.responses.zip

The archive of the response history and of scenario runs, placed next to the project.

Do not commit it — add it to .gitignore. It grows quickly and can contain response data.

restorm.env

The local secrets file, next to the project.

Never commit it.

Recommended .gitignore

# Restorm response and run history
*.responses.zip

# Restorm local secrets
restorm.env

Imported formats

Restorm reads twenty-four further import formats. See Importing an API.