BOAT
Download

Using BOAT

Accounts and workspaces

Local accounts, personal and team workspaces, project invitations and role permissions.

Accounts

  • Anyone who can reach BOAT can sign up with a User ID and password. No email address is collected.
  • User IDs contain only English letters and numbers and are case-sensitive: Alice and alice are different accounts.
  • Because there is no email, password recovery happens on the server with the CLI.

The user commands work even while BOAT is stopped:

boat user list
boat user create Alice
boat user set-password Alice
boat user delete Alice --yes

Passwords are entered hidden and confirmed interactively. For automation, pipe the password in with --password-stdin; there is deliberately no flag that takes the password as an argument.

printf '%s\n' "$NEW_PASSWORD" | boat user set-password Alice --password-stdin

Workspaces

Personal workspace. Every user has exactly one. You can create projects in it and invite other users to individual projects. Collaborators do not join your workspace. Projects you have been invited to show up on your own personal dashboard.

Team workspaces. Anyone can create as many team workspaces as they need. Project invitations in a team are limited to members of that team, and team membership alone does not grant access to every project. Each project has its own member list.

boat workspace list
boat workspace list --owner Alice --type team --json

Invitations

Invite people by their exact User ID, or pick them from the list of eligible users. Access is created only when the invitation is accepted. Project owners and admins can change a pending invitation's role or cancel it.

Removing someone from a project takes effect immediately, including for open project pages, image URLs, the model list, background jobs and export downloads.

Roles

Roles are presets of permissions. The server checks permissions on every request.

Role View Annotate Manage data Auto-label Export Settings Members Delete project
Personal owner ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Personal collaborator ✓ ✓ ✓ ✓ ✓
Team owner ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Team admin ✓ ✓ ✓ ✓ ✓ ✓ ✓
Team labeler ✓ ✓ ✓
Team viewer ✓

Manage data covers uploading and deleting images, videos and labels. Settings covers the project name, classes and status.

↑↓ navigate↵ open