← Back to Atlas
Setup guide

Get Atlas up and running

Atlas runs on your computer and can also be controlled from your Android phone. Start with the desktop setup below. Once Atlas is running on your computer, you can connect your phone as a remote client.

Desktop · Linux

Set up Atlas on your computer

The desktop version does the actual processing and runs Atlas locally on your computer. Complete these steps before setting up the Android app.

1

Download Atlas

Download Atlas-linux.zip to your Linux computer.

The current download is split into three parts. If your browser asks whether it is okay to download multiple files, allow the downloads.

Single download coming soon!

After downloading the three parts, you should have these three files in your Downloads folder:

  • Atlas-linux-split.zip
  • Atlas-linux-split.z01
  • Atlas-linux-split.z02

Make sure all three files are in the same folder. Your Downloads folder is fine.

Combine the three files

  1. Open your Downloads folder.
  2. Right-click an empty area inside the folder.
  3. Choose Open in Terminal.
    If you don't see this option, open the Terminal app from your applications menu instead.
  4. A window with text will appear. This is the Terminal.
  5. Copy and paste the command below into the Terminal, then press Enter:
zip -F Atlas-linux-split.zip --out Atlas-linux-full.zip
  1. Wait for the command to finish. A new file called Atlas-linux-full.zip should appear in your Downloads folder. This combines the three downloaded parts back into one complete file that you can extract and install.
  2. Right-click Atlas-linux-full.zip and choose Extract Here.
  3. Open the extracted Atlas folder and continue with the installation instructions below.
2

Run the Atlas installer

Open a Terminal (same way as above) inside the Atlas folder and run the installer:

./install.sh

The installer will set up the files Atlas needs on your computer.

Tip: You do not need to activate a Python virtual environment before running the installer. Atlas's installation process handles its own environment.
3

Set up the local AI models

Atlas uses Ollama to run its local AI models. Make sure Ollama is installed and running on your computer, then download the models Atlas uses by opening the Terminal (same way as above) and running these commands.

curl -fsSL https://ollama.com/install.sh | sh
ollama pull phi3:mini
ollama pull mistral:7b
ollama pull deepseek-coder:6.7b
ollama pull llava

These models are used for different tasks, including everyday conversations, planning, code generation, and image or camera analysis.

Important: The models are downloaded to your computer and can require several gigabytes of storage. Download time will depend on your internet connection.
4

Optional: Connect Google services when you first use them

Atlas can work with Google Calendar and Gmail. You do not need to enter your Google password into Atlas.

The first time you use an Atlas command that needs Gmail or Google Calendar, a Google sign-in page will open in your browser.

  • Sign in to the Google account you want Atlas to use.
  • Review the permissions Atlas is requesting.
  • Allow access to the Gmail and/or Google Calendar features you want to use.

After authorization, Atlas can use the approved Google services without requiring you to enter your Google password into the application.

Privacy: Google access is permission-based. You choose which Google account Atlas connects to and which requested services you allow. We have no access to your emails or calendar.
5

Optional: Connect Gemini

Atlas can use Google's Gemini models as an optional cloud-based AI service. You only need to complete this step if you want to use Gemini.

The first time Atlas needs Gemini, it will ask for a Gemini API key. You can create one through Google AI Studio.

Sign in with your Google account, create an API key, then copy the key and paste it into the Atlas text area labeled Type a command when prompted.

Keep your API key private. Treat it like a password. Do not post it publicly, include it in screenshots, or commit it to GitHub.
6

Optional: Connect Claude

Atlas can also use Anthropic's Claude models as an optional cloud-based AI service. You only need to complete this step if you want to use Claude.

Create a Claude API key

  1. Open the Anthropic Console in your web browser and sign in or create an account.
  2. Open the API key management area in the Console and choose the option to create a new API key.
  3. Give the key a name that helps you remember what it is for, such as Atlas.
  4. Create the key and copy it. Keep it somewhere secure while you complete the Atlas setup.

Anthropic's API uses prepaid usage credits. If your API account has not been funded yet, open the Billing area in the Anthropic Console and add usage credits before trying to use Claude through Atlas.

Once Atlas asks for your Claude API key, paste the key into the Atlas text area labeled Type a command when prompted.

Important: A Claude.ai subscription and Anthropic API usage are separate. Having a paid Claude chat subscription does not automatically provide API credits for Atlas.
Keep your API key private. Treat it like a password. Do not post it publicly, include it in screenshots, or commit it to GitHub.
✓

Desktop setup complete

Start Atlas and make sure it is working on your computer before continuing with the phone setup below.

If you want Atlas to always remain visible on your screen, right-click where it says A.T.L.A.S and select Sticky window.

The Android app is a remote client. Atlas continues to run on your computer, while your phone sends commands to it and receives the responses.

Atlas Mobile can activate Atlas on your computer remotely. Your computer needs to be unlocked for the initial connection. After the connection is established, your computer can be locked.

Mobile · Android

Connect Atlas to your phone

The Android app does not run Atlas by itself. It connects to Atlas running on your computer through a private Tailscale network.

1

Install Tailscale on your computer

Tailscale creates a private connection between your computer and phone. This allows the two devices to communicate without exposing Atlas directly to the public internet.

On your Linux computer, install Tailscale by opening the Terminal (same way as above) and copy/pasting this command:

curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up

Follow the sign-in instructions that appear.

2

Install Tailscale on your phone

Install the Tailscale app on your Android phone and sign in using the same Tailscale account you used on your computer.

Make sure Tailscale is turned on whenever you want your phone to connect to Atlas.

Good to know: Your phone and computer do not need to be connected to the same Wi-Fi network. Tailscale can connect them over different networks.
3

Install the Atlas Android app

Download Atlas.apk directly to your Android phone, or transfer the file from your computer to your phone.

Android may ask for permission to install an app from an unknown or third-party source. Allow the installation when prompted, then install Atlas.apk.

Important: Only install the Atlas APK from this site.
4

Generate your Atlas API key

Make sure Atlas is running on your computer.

In the Atlas desktop application, click the ⚙ Settings icon between Cancel and Mute.

Select:

Generate Mobile QR Code

Atlas will display a QR code containing your mobile API key. You will scan this code with the camera button next to the API Key field in the Android app.

Keep the QR code private. Anyone with access to this code may be able to authenticate with your Atlas installation. Do not post or share it.
5

Enter your Atlas connection settings

Open the Atlas Android app and go to Settings. You will need to enter four pieces of information:

  1. Server URL — enter the address and port of the Atlas server running on your computer. See step 6 below to find the Tailscale IP address. The port, or last 4 digits is 8000 by default
    Example: http://xxx.xx.xxx.xx:xxxx
  2. SSH Host — enter your computer's Tailscale IP address. See step 6 below.
    Example: xxx.xx.xxx.xx
  3. SSH Username — enter the username you use to log in to your Linux computer.
  4. API Key — use the camera button next to the API Key field to scan the QR code you generated in the previous step.
Important: The QR code is only used for the API Key. The Server URL, SSH Host, and SSH Username are entered separately in the Android app's Settings.
6

Install Tailscale and Find your Tailscale IP address

You need to find your computer's Tailscale IP address, open a Terminal on your computer and run:

pip install fastapi uvicorn qrcode Pillow --break-system-packages
openssl rand -hex 32 > ~/.config/atlas/api_key
chmod 600 ~/.config/atlas/api_key
tailscale ip -4
sudo apt install openssh-server
sudo systemctl enable --now ssh

Use the address shown by this command for both the SSH Host and, when appropriate, the IP portion of your Server URL.

Keep this private: Your Tailscale address is part of your private connection information. Do not post your complete connection settings publicly.
7

Complete the first connection

Once your four settings are entered, save the settings and connect to Atlas.

During every connection, Atlas will ask for your Linux computer password to verify the connection and keep your data secure. We have no access to any data on your phone or computer.

Enter the same password you normally use to log in to your Linux computer.

Your Google password is not used here. This is your local Linux login password for the computer running Atlas.
✓

You're all set

Once your phone is connected, you can use the Atlas Android app as a remote client for Atlas running on your computer.

Your computer needs to be powered on and unlocked for Atlas Mobile to connect. You can lock your computer after the connection is made.

The phone app does not run Atlas independently. Your desktop computer continues to handle the AI processing and Atlas's other capabilities.

Troubleshooting

Having trouble?

Here are some of the most common setup and connection issues you may run into.

Tailscale says "NeedsLogin"

If you run tailscale ip -4 and see no current Tailscale IPs; state: NeedsLogin, Tailscale is installed but your computer is no longer signed in.

Open a Terminal on your computer and run:

sudo tailscale up

Follow the sign-in link that appears and sign in to the same Tailscale account you use on your phone. Then run:

tailscale ip -4

You should now see a Tailscale IP address. Use that address for the SSH Host in the Atlas Android app.

My phone cannot connect to Atlas

Check these things first:

  • Make sure Atlas is installed on your computer.
  • Make sure Tailscale is turned on on both your computer and phone.
  • Make sure both devices are signed in to the same Tailscale account.
  • Make sure the SSH Host is your computer's current Tailscale IP address.
  • Make sure the Server URL uses the correct IP address and port.
  • Make sure the SSH Username is your Linux computer username.
  • Make sure the API Key was scanned from the QR code generated by your desktop Atlas installation.
Tip: If you recently logged back into Tailscale on your phone or computer, check the Tailscale IP address again. It is better to use the current address shown by tailscale ip -4 than an old address you may have saved previously.

The Tailscale IP changed

If Atlas Mobile worked before but suddenly cannot connect, your computer's Tailscale address may have changed or Tailscale may need to be signed in again.

On your computer, run:

tailscale ip -4

If an address is displayed, update the SSH Host in the Android app if it no longer matches. Also update the IP portion of the Server URL if necessary.

The API QR code will not scan

  • Make sure Atlas is running on the computer.
  • Generate a new QR code from ⚙ Settings → Generate Mobile QR Code.
  • In the Android app, use the camera/scan button next to the API Key field.
  • Make sure the QR code is clearly visible and your phone camera can focus on it.
  • Do not try to enter the QR code contents into the Server URL, SSH Host, or SSH Username fields.
Security: Treat the mobile API QR code like a password. Only scan a QR code generated by your own desktop Atlas installation, and do not share or post it publicly.

Atlas asks for my password

When Atlas Mobile makes a connection, it asks for the password you normally use to log in to the Linux computer running Atlas.

This is your Linux computer login password, not your Google password, Tailscale password, or Atlas API key.

Google Gmail or Calendar is not working

The first time Atlas uses a Google service, a Google sign-in and permissions page should open in your browser.

  • Make sure you signed in to the Google account you want Atlas to use.
  • Review and allow the Gmail and/or Calendar permissions you want to use.
  • Do not enter your Google password directly into Atlas.

If you denied a permission or signed in with the wrong Google account, you may need to review Atlas's Google authorization in your Google account before trying again.

Ollama says a model is missing

Make sure Ollama is installed and running, then download the Atlas models from a Terminal:

curl -fsSL https://ollama.com/install.sh | sh ollama pull phi3:mini
ollama pull mistral:7b
ollama pull deepseek-coder:6.7b
ollama pull llava

Model downloads can take some time and require several gigabytes of storage.

The installer or a command says "Permission denied"

Make sure you are running the command from the correct Atlas folder and that the installer can be executed.

If ./install.sh reports that permission is denied, run:

chmod +x install.sh

Then run the installer again:

./install.sh

The split download will not combine

Make sure all three downloaded files are in the same folder:

  • Atlas-linux-split.zip
  • Atlas-linux-split.z01
  • Atlas-linux-split.z02

Open a Terminal in that folder and run:

zip -F Atlas-linux-split.zip --out Atlas-linux-full.zip

If the command reports a problem, make sure each part finished downloading completely and that the filenames have not been changed.

Still stuck?

If you are still having trouble, include the exact error message you see when opening an issue. A screenshot can also help, but never include passwords, API keys, QR codes, or other private connection information.