Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hyperspeed.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Hyperspeed runs as a single workspace per installation. Every person who joins your instance becomes a member of that one organization. You control what each member can do through roles and, optionally, by restricting them to specific spaces.

Single workspace model

Each Hyperspeed installation has exactly one organization. The first person to register creates the workspace during the setup wizard. Everyone who joins after that—via invite or open registration—becomes a member of the same workspace. You cannot create a second organization within a single installation.

Member roles

Roles are how you grant permissions to members. Hyperspeed ships with system roles that you cannot rename or modify. You can also create custom roles with any combination of permissions.

System roles

System roles are created automatically when the workspace is initialized. Their permissions are fixed and cannot be changed.
The owner system role cannot be deleted.

Custom roles

Custom roles let you define precise permission sets for your team. You can create as many custom roles as you need, and assign multiple roles to the same member.

Creating a custom role

1

Open workspace settings

Navigate to Settings → Roles in the sidebar.
2

Create the role

Click New role, enter a name, and select the permissions you want to grant.
3

Save

Click Create. The role is immediately available to assign to members.

Editing a custom role

You can rename a custom role or replace its permissions at any time. Changes apply to all members who hold that role immediately.
You cannot rename or modify permissions on system roles.

Deleting a custom role

You can delete any custom role except the owner role. Deleting a role removes it from all members who currently hold it.

Permissions reference

The table below lists every permission available in Hyperspeed.
PermissionWhat it grants
org.manageManage workspace settings (name, registration mode, etc.)
org.members.manageInvite members, approve signup requests, manage roles
space.createCreate new spaces
space.deleteDelete spaces
space.members.manageAdd or remove members from a space
board.readView boards
board.writeCreate and edit boards
tasks.readView tasks
tasks.writeCreate, edit, and delete tasks
chat.readRead chat messages
chat.writeSend chat messages
files.readView and download files
files.writeUpload and edit files
files.deleteDelete files
terminal.useOpen a terminal session
ssh_connections.manageCreate and manage stored SSH connections
agent.tools.invokeInvoke agent tools
datasets.readView datasets
datasets.writeCreate and modify datasets

Assigning roles to members

You need the org.members.manage permission to assign or change roles.
1

Open the members list

Navigate to Settings → Members.
2

Select a member

Click the member you want to update.
3

Set roles

Choose one or more roles from the dropdown and save. The member’s effective permissions are the union of all their assigned roles.

Space-level access control

Spaces are the top-level containers for projects and work in your workspace. By default, members can access spaces according to their workspace-level permissions, but you can restrict a space so that only explicitly added members can see it. To manage who belongs to a space, you need the space.members.manage permission.
  • Add a member to a space: Go to the space settings and add the member by name.
  • Remove a member from a space: Remove them from the space member list. Their workspace membership and roles are unaffected.
Use space-level membership to isolate sensitive projects without creating separate workspaces or changing workspace-wide roles.

Registration modes

You can control how new people join the workspace under Settings → General.

Invite-only

Only members with org.members.manage can generate invite links. No one can register without one. This is the most restrictive mode and is appropriate when your workspace should never be visible to outside users.

Open registration

Anyone who can reach your Hyperspeed URL can submit a registration request. The request enters a pending queue; no account is created until you approve it.
Open registration does not grant immediate access. Users are placed in a pending state until an admin approves or denies their request.

Approving signup requests

When open registration is enabled and a user submits a registration form, they appear in the signup request queue. You need the org.members.manage permission to act on requests.
1

Open pending requests

Navigate to Settings → Members → Pending requests.
2

Review the request

Check the user’s name and email.
3

Approve or deny

Click Approve to create the account and add the user as a member, or Deny to reject the request.
Approving a request creates the user’s account and assigns them the default member role. You can change their roles afterward from the members list.