docs GitHub

Get startedDraft

Your first hour

Eight steps, each one small enough to check before the next. You need a Linux server you can open a terminal on (or a Mac that stays on), your Mac, your phone, a Claude, ChatGPT or Grok account, and nothing else to sign up for. If a step stops, troubleshooting has the fix, and vyre doctor says what is wrong in under two seconds.

Use your own details throughout. Nothing here needs example data.

1. Set up your server (about 15 minutes)

Open the Vyre app, choose your name, create a space, and paste the one line it shows into a terminal on that server. The app then checks four words with you, and walks you through giving the space a look, your AI account, your tools and a Kit. Install walks every screen.

Check: the terminal on the server says Vyre is running on this server. and shows four words that match the app, and vyre status on the server says Vyre is running.

2. Sign in to your AI (2 minutes)

On setup's Sign in to your AI screen, press Sign in with Claude (or ChatGPT or Grok). A page on the provider asks you to approve, and the page shows a code to enter or a box to paste the code the provider gives you. The token goes straight into the vault, sealed on your server: you never copy it into a terminal or a file.

Skipped it? In the Vyre app, Settings, Assistants has the Claude sign-in again (Open the sign-in).

Check: Settings, AI accounts shows Claude as connected.

3. Open Vyre on your phone (4 minutes)

  1. Open the Vyre app on the phone and scan the code your server or a computer you are signed in on shows, or paste its long code. Both screens show the same three words; say yes only if they match. There is nothing to install or sign in to first.
  2. Or open your address with /now at the end, for example https://alex.vyre.run/now, in Safari (iPhone) or Chrome (Android).
  3. Add it to the home screen: on an iPhone, Share, then Add to Home Screen; on Android, the browser menu, then Install app.
  4. Open it from the icon and turn on notifications when Now offers them.

Step 4 pairs your Mac with the server. The phone's Now then shows "A Mac wants to pair". Press Approve only if it is your Mac, and confirm with Face ID. A Mac can't approve itself, which is why the phone comes first (known gaps).

Check: on the Mac, once step 4 is done, vyre link says "linked to" and names your server.

4. Put Lumen on your Mac and ask it (5 minutes)

On the Mac, install the vyre command and pair it with your server:

npm install -g https://vyre.run/box/vyre.tgz
vyre up --connect https://alex.vyre.run

Approve the pairing on your phone, as step 3 says. vyre up then builds Lumen on your Mac and opens it. To build it yourself, or if it did not open:

vyre capsule

Allow Input Monitoring when macOS asks (Allow double-Control), then press Control twice anywhere.

Ask something about your own recent work, in your own words, and press Return. The reply comes from your assistant, and facts marked in gold came from your memory, not a model.

To see the sources behind an answer, ask the same thing from the terminal:

vyre memory ask "what did I work on yesterday" --sources

It prints the answer, how sure it is, and the lines from your sessions it rests on.

5. Send one email (3 minutes)

  1. In the Vyre app, Settings, Connections, Add Google account, Sign in with Google. Pick your account and allow what it asks. (From a terminal: vyre connect add google <name> --sign-in.)
  2. In Lumen or in Chat, ask your assistant to email you a one-line note, to your own address.
  3. The email does not go. It waits at the Gate, and Now lists it as waiting on you. Open it to see what would leave.
  4. Approve it, and confirm with Face ID, Touch ID or your passkey. One proof covers the next 30 minutes on that device.

Check: the note is in your inbox, and Now no longer shows it. Hold and approve a send has the rules.

6. Let Vyre use the Mac (2 minutes)

In Lumen, type do and a small task on this Mac, like opening an app you use every day, and press Return. The first time, macOS asks for Accessibility and Screen Recording for Vyre: allow both in System Settings, Privacy and Security. A pill shows while Vyre drives, each step on screen. Press Esc to stop it at once. Anything that sends, pays or deletes still waits for you.

7. Open Settings (1 minute)

Open the Vyre app (your box's address, or the phone icon) and go to Settings. Look at Devices, Notifications (quiet hours) and Account and recovery (how you sign in).

8. Change a colour (2 minutes)

Settings, Appearance switches the theme between Dark, Paper and System. Brand accent picks one of the accents or Custom, where Custom accent takes a colour of your own.

When you are done

  • vyre doctor for a health check any time.
  • vyre tips for short tips on every part of Vyre.
  • Your first day for what to try next.