Install and first chat
Familiar installs as a background service on one computer. That computer keeps the conversation and its data. Your other devices reach it through a browser.
Run the installer
Section titled “Run the installer”curl -fsSL https://github.com/AidanZealley/familiar/releases/latest/download/install.sh | shcurl -fsSL https://github.com/AidanZealley/familiar/releases/latest/download/install.sh | shirm https://github.com/AidanZealley/familiar/releases/latest/download/install.ps1 | iexIt downloads Node 24 if you don’t already have 24.19 or newer, installs the familiar command and starts guided setup.
The installer takes the latest stable release. To install a particular release, including a prerelease, set FAMILIAR_VERSION to its tag, such as FAMILIAR_VERSION=v1.2.3 before sh on macOS and Linux, or $env:FAMILIAR_VERSION = 'v1.2.3' before running it in PowerShell.
Finish setup
Section titled “Finish setup”-
Name your assistant. Press Enter to keep the default,
Familiar. You can rename it later. -
Sign in with your ChatGPT subscription. Setup prints a sign-in link and opens it in your browser when it can. Over SSH or on a machine without a display, open the link on another device. When you finish, the browser lands on a page that won’t load. Copy that page’s full address and paste it into the terminal.
This login is how Familiar reaches the model. It doesn’t sign you in to Familiar.
-
Open the URL setup prints,
http://127.0.0.1:4317, and say hello.
If you stop setup partway, run familiar again to pick up where it left off.
Reach it from your other devices
Section titled “Reach it from your other devices”If Tailscale is installed and signed in, setup publishes Familiar at a private HTTPS address on your tailnet and prints it. Open that address on your phone or laptop. HTTPS is also what makes notifications work.
Without Tailscale, Familiar listens only on 127.0.0.1, so only the machine it runs on can reach it.
Who can use it
Section titled “Who can use it”An installed Familiar has one owner and no separate login. Anyone who can reach its address can read the conversation, change its sign-in and install tools. Tailscale access keeps it to your own devices. Don’t expose it to the public internet.
Platform support
Section titled “Platform support”macOS and Linux have been tested on real machines. Windows passes automated CI. It hasn’t had real-machine testing yet.