Getting started

Join a team

Join a team's Neuralis from an invite link — in the browser, in the desktop app or from the CLI — and, if you want, let that host use your own computer as a device.

A team's Neuralis is a host someone else runs: a company server, or a colleague's desktop app made reachable. Joining it takes an account there and, for most people, an invite link. What you may do once inside is decided by the role the invite carries and by the project's admins — never by the app you join from.

A project admin issues it in the Admin widget's Users tab (or an agent with the invite skill does), for one email address and one role. It works once and stays valid for inviteLinkTtlHours — 7 days by default — unless the admin revokes it first. Opening it shows the host's /invite page: you choose your own password, or join with the account you already have on that host. The link's secret travels in the part of the address after #, so it is never sent in a request until the page redeems it.

A link issued by a host that is reachable only on its own computer (localhost, 127.0.0.1) opens nowhere else; the Users tab warns when it issues one. The host's operator sets the address people reach it on (deployment).

In the browser

Open the link, set your password, sign in. That is all a browser needs.

In the desktop app

The /invite page offers Open in Neuralis Desktop, a neuralis://join?host=…#t=… link the installed desktop app opens. The app names the host and asks before it does anything; the token goes only to the host the link names. You can also paste an invite link, an invite page address or a host's address into the host list — + in the tab strip. Each other host opens in a tab of its own, with its own sign-in and cookies; your local workspace keeps its own, and its own address opens in the first tab.

An app run straight from an unpacked build on Linux registers no neuralis:// handler; there, paste the link into the host list (+).

From the command line

With an account on the host, the CLI signs in to it from your own terminal:

neuralis login --host https://team.example.com
neuralis whoami

Bring your own computer

Joining a host does not open your computer to it. To let the team's agents read a folder of yours or run commands there, pair it with that host — Pair… beside that host on the desktop app's This computer page, or neuralis device pair --host https://team.example.com — and grant only the folders you choose: devices.

On this page