beval/roster
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Page: Projects and Environments
Pages
API Reference Architecture Contributing Development Export FAQ Getting Started History Home Installation Keyboard Shortcuts Projects and Environments Scripts Sensitive Variables Translation Variables
Clone
2
Projects and Environments
Pavel Baksy edited this page 2026-01-13 16:59:00 +01:00
Table of Contents

Projects and Environments

Projects help organize related HTTP requests, while environments allow you to manage different configurations (development, staging, production).

Projects

What is a Project?

A project is a container for:

  • Saved requests - Your HTTP requests
  • Variables - Shared variables across requests
  • Environments - Different configurations (dev, prod, etc.)

Example projects:

  • "GitHub API"
  • "My App Backend"
  • "Payment Integration"
  • "Authentication Service"

Creating a Project

  1. Click the "+" icon in top-left
  2. Enter project name
  3. Click "Create"

A default "Default" environment is automatically created.

Accessing Projects

Projects appear in the sidebar on the left side:

  • Click a project to expand/collapse
  • Shows saved requests within the project
  • Active project highlighted

Editing a Project

  1. Click the "three-dots" symbol near the project name in sidebar
  2. Select "Edit Project"
  3. Enter new name or click icon to choose from grid
  4. Click "Save"

Deleting a Project

  1. Right-click the project in sidebar
  2. Select "Delete"
  3. Confirm deletion

Warning: This deletes all requests, environments, and variables in the project!

Environments

What is an Environment?

An environment is a set of variable values. Common environments:

  • Production - Live API with real credentials
  • Staging - Pre-production testing
  • Development - Local development server
  • Testing - Automated test environment

Managing Environments

See Variables for complete environment and variable management documentation.

Quick access:

  1. Select a project
  2. Click the "three-dots" symbol near the project name in sidebar
  3. Click **"Manage Environments"
  4. Manage environments and variables in dialog

Default Environment

Each project starts with a "Default" environment. You can:

  • Rename it
  • Add more environments
  • Delete it (if you have at least one other environment)

Saved Requests

Saving a Request

  1. Configure your request (URL, method, headers, body)
  2. Click "Save" button in header
  3. Enter request name (e.g., "Get User Profile")
  4. Select a project
  5. Click "Save"

Opening a Saved Request

  1. Navigate to your project
  2. Click on a saved request
  3. Request opens in a new tab

Editing a Saved Request

  1. Open the request
  2. Make changes
  3. Click "Save" (or Ctrl+S)
  4. Select Project and enter request name
  5. Click Save

Modified indicator: Unsaved changes show a dot (•) on the tab label.

Deleting a Saved Request

  1. Click "x" icon near the request name in sidebar
  2. Confirm deletion

Requests can have preprocessing and postprocessing scripts attached. See Scripts for details.

Data Storage

File Location

Native:

~/.local/share/cz.bugsy.roster/requests.json

Flatpak:

~/.var/app/cz.bugsy.roster/data/cz.bugsy.roster/requests.json

Sensitive Variables

Regular variables stored in JSON. Sensitive variables stored in GNOME Keyring (encrypted).

See Sensitive-Variables for details.

Backup

To backup your projects:

  1. Copy the requests.json file
  2. For sensitive variables: backup your GNOME Keyring (see Sensitive-Variables)

Next Steps