ArgentOSDocs

Getting Started

Get ArgentOS up and running in under 5 minutes.

Prerequisites

  • Node.js 22+ (use nvm, not Homebrew on macOS)
  • An Anthropic API key or Max subscription setup token
  • A messaging platform account (Telegram, Discord, WhatsApp, etc.)

Install

npx argentos init

This will:

  1. Create the ~/.argentos/ state directory
  2. Generate a default argent.json configuration
  3. Install the argent CLI globally

Configure your API key

argent setup

Follow the wizard to connect your Anthropic account. ArgentOS supports:

  • Setup tokens from Anthropic Max subscriptions (weekly quota billing)
  • API keys for per-token billing with prompt caching support
  • Multiple auth profiles for automatic failover between accounts

Start the Gateway

argent gateway start

The gateway is the always-on process that manages your agent, channels, and sessions. It runs as a background service (launchd on macOS, systemd on Linux).

Connect a Channel

argent channels add telegram

Follow the prompts to connect your first messaging channel. See the Channels section for platform-specific guides.

Open the Dashboard

argent dashboard

Opens the web dashboard at http://localhost:3141 where you can chat with your agent, manage tasks, and monitor activity.