Skip to content

About

Vibe-code on the go with AirCodum Agentum! Control Claude Code, OpenAI Codex and GitHub Copilot sessions right from your phone. Supports a VNC mode for more user control. Self-host your own servers for better privacy

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Repository files navigation

Agentum

This release requires the updated Agentum mobile app and one-time pairing. Older anonymous apps cannot connect. See connection setup.

Control AI coding agents from your phone. Mirror Claude Code, GitHub Copilot, OpenAI Codex and Cline to mobile.

How It Works

┌──────────────┐     WebSocket      ┌──────────────┐
│  Your Phone  │ ◄────────────────► │   Desktop    │
│  (Agentum    │                    │(ag start)│
│   Mobile)    │                    │              │
└──────────────┘                    └──────────────┘
                                           │
                                    ┌──────┴──────┐
                                    │ AI Agents   │
                                    │ Claude Code │
                                    │ Copilot     │
                                    │ Codex       │
                                    └─────────────┘

Prerequisites

You need Node.js (v18+) installed. Then, install and authenticate the AI agents you want to control:

Agent Install Login
Claude Code npm install -g @anthropic-ai/claude-code claude (follow prompts)
GitHub Copilot gh extension install github/gh-copilot gh auth login
OpenAI Codex npm install -g @openai/codex codex (follow prompts)
Cline npm install -g cline cline auth

Only install and authenticate the agents you plan to use.


Quick Setup

Agentum 2.0.1 is available on npm. The commands below run the latest release directly with npx, including the QR image fix. A built package is also available from GitHub Releases.

Use AirCodum Agentum 1.1 or later on your phone. Connect your phone and computer to the same Wi-Fi for initial setup.

1. Start Agentum on your computer

Open a terminal on your computer and run:

npx agentum@latest start

If npm asks to install Agentum, enter y. No global installation is required. Run this from your project folder if you want new sessions to use that folder by default.

Leave this terminal running. It shows your computer name, network addresses, and ports: 11042 for terminal sessions and 11043 for desktop sharing. The QR code appears in the next step.

2. Open the pairing QR image

Open a second terminal tab or window on your computer (⌘T in macOS Terminal), then run:

npx agentum@latest pair --open

A square QR image opens in your computer's image viewer. This avoids terminal fonts or line wrapping distorting the code. The image's file path and your host address, ports, and pairing key are also printed in the second terminal. This image option requires CLI 2.0.1 or later.

For a terminal QR instead, run npx agentum@latest pair without --open. The code appears directly in that second terminal, and a clean PNG image is saved as a fallback. If the terminal is too narrow, Agentum prints the image path instead of a wrapped QR code.

3. Pair your phone

On your phone, open Agentum → Add computer → Scan QR code. Point your phone's camera at the QR image opened on your computer.

If scanning fails, enter the host, terminal port, desktop port, and pairing key printed in the second terminal into the app manually. Keep the first terminal (start) running while you use Agentum.

If you have several network adapters, choose the address your phone can reach (replace the example with your computer's Wi-Fi or Tailscale address):

npx agentum@latest pair --open --host 192.168.1.10

Phones on the same Wi-Fi connect directly; Tailscale is optional for access from other networks. Public remote access requires a trusted TLS reverse proxy. See setup details.

Optional: install globally to use ag

If you prefer the shorter ag command:

npm install -g agentum@latest

Installation alone does not start the server or display a QR code. Run ag start in one terminal, leave it running, then run ag pair --open in a second terminal to open the QR image. Scan it in the phone app as described above.

The examples below use ag. Without a global install, replace ag with npx agentum@latest (for example, npx agentum@latest list).

Multiple computers and instances

Save each computer in the app and tap its card to switch. For separate Agentum instances on one computer, choose different port pairs:

ag start --port 11042 --name Work
ag start --port 12042 --name Personal
ag pair --port 12042

Desktop ports default to the terminal port plus one. Each terminal port has a persistent identity, so the app can detect an address that now points to a different instance. Terminal/agent sessions belong to their instance. Desktop mode controls the same foreground desktop on that computer; separate instances are not separate virtual desktops.

Desktop supports pinch zoom and pan in the updated app, wheel scrolling, right-click, explicit drag, and text/shortcut input. Native Screen Recording and Accessibility permissions are required on macOS.

Cline sessions

After installing and authenticating Cline, restart ag from the same terminal so Cline is on its PATH. In the updated app, choose Cline → New, name the session, and optionally enter an absolute project folder on this computer. Leaving it empty uses the directory where ag started.

The preset launches the official interactive CLI with cline --tui --auto-approve false. Use the phone’s terminal key row for arrows, Enter, Tab, Esc and Ctrl+C; swipe horizontally to see additional keys. Tool approval prompts remain enabled. An unavailable installation produces setup guidance in the app.

Each new session starts a separate conversation. Running PTYs stay alive when a phone disconnects, and reattaching replays their terminal output. Stopping the server ends its PTYs; use Cline’s own history/resume commands from a manual terminal if you need an older conversation. Older Agentum servers can run cline manually in PTY mode, while the dedicated preset requires Agentum 2 and the updated app.

Windows and WSL

Run Agentum in Windows PowerShell on the machine that owns the desktop. WSL/WSLg cannot capture the Windows host desktop; Agentum detects this and keeps terminal sessions available with explicit guidance. For WSL commands, create a terminal session running wsl.exe from the Windows-hosted server.


Commands

ag start

Start the server. Run this first.

ag start                    # Default: port 11042
ag start --port 8080        # Custom port
ag start --no-vnc           # Disable screen sharing

ag pair

Open a clean QR image with --open, or display a terminal QR without it. Both modes save a PNG and print its file path alongside manual connection details. Keep the server running in another terminal while you pair your phone.

ag pair --open                # Recommended: open a square QR image
ag pair                       # Terminal QR plus saved PNG fallback
ag pair --host 192.168.1.10    # Choose this computer's reachable address
ag pair --port 12042          # Match a server started with --port 12042

If there is no image viewer (for example, over SSH), open the printed image path on a computer with a display or enter the connection details manually. The image contains your pairing key; keep it private and delete it when you no longer need it. ag pair --json prints only the pairing JSON and does not create an image.

ag run <command>

Run any command and mirror output to mobile.

ag run "npm test"
ag run "python train.py" -d     # Detached (background)
ag run "make build" -n build    # Named session

ag list

Show active sessions.

ag attach <id>

Attach to a session locally. Press Ctrl+] to detach.

ag kill <id>

Stop a session.

ag screenshot

Capture screen to disk.

ag screenshot                # Saves to /tmp
ag screenshot -o ./shots     # Custom directory

ag notify

Push notification to phone.

ag notify -t "Done" -b "Build complete"
ag notify -t "Error" -b "Tests failed" -P high

Remote Access (Tailscale) - Highly Recommended

Access from anywhere, not just your local network. Works through firewalls and NATs.

Setup

  1. Install Tailscale on desktop and phone
  2. Sign in with same account on both
  3. Start Tailscale:
    tailscale up
  4. Connect from mobile:
    • IP/Host: Your Tailscale IP (tailscale ip -4) or MagicDNS hostname (e.g., your-desktop-name)
    • Port: 11042

Ports

Port Service Description
11042 WebSocket Mobile ↔ Desktop
11043 VNC Screen sharing (optional)


Troubleshooting

Where is the QR code? Run npx agentum@latest pair --open (or ag pair --open after a global install) in a second terminal. A QR image opens in your computer's image viewer, and its path is printed in the terminal. Without --open, the QR appears directly in the terminal if it is wide enough. Installing the package or running start does not display it.

QR code looks distorted or won't scan? Run npx agentum@latest pair --open to scan a square PNG image unaffected by terminal formatting. You can also open the file printed after QR image:. Scan using Agentum → Add computer → Scan QR code. On an older CLI without --open, update with npm install -g agentum@latest, or widen the terminal and use a monospaced font with normal line spacing. If scanning still fails, enter the printed host, ports, and pairing key manually in the app.

pair is an unknown command? Check ag --version. Pairing requires Agentum 2 or later. Run npm install -g agentum@latest to update, or use npx agentum@latest pair directly.

Port in use?

ag start --port 8080

Can't connect from phone?

  • Same WiFi network?
  • Firewall blocking port 11042?
  • Try: ping <desktop-ip> from phone

Find your IP:

ifconfig | grep "inet "

Links

About

Vibe-code on the go with AirCodum Agentum! Control Claude Code, OpenAI Codex and GitHub Copilot sessions right from your phone. Supports a VNC mode for more user control. Self-host your own servers for better privacy

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages