Docs

Set up a team

Create a team, share connections and credentials with it, and invite teammates with a one-time link, or join a team you've been invited to.

A team is a shared workspace: connections, credentials, tags and known hosts that everyone in it can use. Its data syncs directly between members' devices, encrypted end to end, with no account and no server in between.

Before you start

• Creating a team needs a Team license. Import it under Manage → License & plan; see pricing. Joining a team someone invites you to works on any plan, Free included.
• Turn on peer networking on your device and on each teammate's: in the sidebar, under Manage, open Network & peers… and choose Turn on.
• Your devices need to reach each other: on the same network, or over a VPN like Tailscale, ZeroTier or WireGuard. The pairing guide covers devices on different networks.

1. Create a team

1. In the sidebar, under Workspaces, choose New team…
2. Give it a name, and a description if you like.
3. Choose Create team.

You're its first admin, and your Team license is attached to it. The team is listed under Workspaces, next to your Personal workspace, and its settings open.

2. Add connections

With the team selected under Workspaces, choose New to add a connection to it. To share ones you already have:

1. Select them in your Personal workspace: Ctrl-click (⌘-click on a Mac) to pick several, or filter the list and press Ctrl+A.
2. Under Copy to workspace, pick the team and choose Copy. For a single connection, choose Copy to… in its details.

Their jump hosts, credentials and tags come along, so the team can connect without anyone sending a password. The originals stay in your Personal workspace.

3. Invite a teammate

1. Hover over the team under Workspaces and choose its settings button (Members, invites and keys).
2. Under Invite someone, pick their role and how long the link lasts: 1 hour, 1 day or 7 days.
3. Choose Create invite link, then Copy.
4. Send the link to that one person, over a channel you trust.

The link carries your device's address, and joining happens with your device directly. Keep it on, with peer networking on, until they've joined. The invite is listed under the link as Waiting, then with their name once it's used. To cancel one, choose Revoke.

4. Join the team

On your teammate's device:

1. Under Workspaces, choose Join a team…
2. Paste the whole terminallynx://invite link. It shows who invites you, to which team, as what role and until when.
3. Choose Join.

The team's records arrive from the admin's device, and the team appears under Workspaces. On the admin's side, the new member shows up under Members. From then on the team syncs between all its members' devices like your own devices do: when they start, every minute while they can reach each other, and moments after a change.

Roles

Every change is signed by the person who made it, and every member's device checks it against their role. A change a Reader couldn't make is refused everywhere. Favorites and recents are yours alone and never sync to the team.

Managing members

Admins manage the team in its settings:

• Change a role with the menu next to a member. A team always keeps at least one admin.
• Remove a member with the button next to them. The team's key is rotated at once, so they can't read anything changed after that. TerminalLynx then lists the credentials they could have seen, under Rotate exposed credentials, so you can change those passwords and keys on the servers too.
• Rotate workspace key seals new changes with a fresh key, whenever you want one.

To leave a team yourself, choose Leave team. If you're its only admin, make someone else an admin first.

Seats and licenses

The Team license attached to a team covers everyone in it, whatever their own plan. Its seats are the people in the teams it's attached to, plus the license holder. An open invite also holds a seat until it's used, revoked or expires.

Without a current Team license, a team is read-only: everyone can still connect, but nothing in it can change until an admin attaches one, at the top of the team's settings. Nothing is locked or deleted.

Troubleshooting

"Turn on peer networking first"

Creating an invite and joining with one both need peer networking on. Turn it on in Network & peers… and try again.

Joining doesn't finish

The joining device can't reach the admin's. Check that the admin's device is on with peer networking on, that both are on the same network or VPN, and that no firewall blocks UDP port 47474.

"This invite expired", "was already used" or "was revoked"

Each link works once, until its expiry. Ask the admin for a new one.

"This team's license has N seats, and they're taken"

Remove a member, revoke an open invite, or get more seats.

"You were added, but the team's records didn't arrive"

You're in the team, but the connection dropped before the data came through. Choose Sync now in Network & peers.

The team shows Read-only

Its Team license has lapsed or was detached. An admin can attach a current one in the team's settings; see Seats and licenses.

Still stuck?

Contact support, with the message you see.