English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page

First steps

Getting started

Install OmeniaClaw, run onboarding, and chat with your AI assistant — all in about 5 minutes. By the end you will have a running Gateway, configured auth, and a working chat session.

What you need

  • Node.js — Node 24 recommended (Node 22.19+ also supported)
  • An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you

Quick setup

  • Install OmeniaClaw

    macOS / Linux

    bash
    curl -fsSL https://omeniaclaw.com/install.sh | bash

    Install Script Process

    Windows (PowerShell)

    powershell
    iwr -useb https://omeniaclaw.com/install.ps1 | iex

  • Run onboarding

    bash
    OmeniaClaw onboard --install-daemon

    The wizard walks you through choosing a model provider, setting an API key, and configuring the Gateway. It takes about 2 minutes.

    See Onboarding (CLI) for the full reference.

  • Verify the Gateway is running

    bash
    OmeniaClaw gateway status

    You should see the Gateway listening on port 18789.

  • Open the dashboard

    bash
    OmeniaClaw dashboard

    This opens the Control UI in your browser. If it loads, everything is working.

  • Send your first message

    Type a message in the Control UI chat and you should get an AI reply.

    Want to chat from your phone instead? The fastest channel to set up is Telegram (just a bot token). See Channels for all options.

    • Advanced: mount a custom Control UI build

    If you maintain a localized or customized dashboard build, point gateway.controlUi.root to a directory that contains your built static assets and index.html.

    bash
    mkdir -p "$HOME/.OmeniaClaw/control-ui-custom"# Copy your built static files into that directory.

    Then set:

    json
    {"gateway": {  "controlUi": {    "enabled": true,    "root": "$HOME/.OmeniaClaw/control-ui-custom"  }}}

    Restart the gateway and reopen the dashboard:

    bash
    OmeniaClaw gateway restartOmeniaClaw dashboard

    What to do next

    Connect a channel

    Discord, Feishu, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more.
    Pairing and safety

    Control who can message your agent.
    Configure the Gateway

    Models, tools, sandbox, and advanced settings.
    Browse tools

    Browser, exec, web search, skills, and plugins.
    Advanced: environment variables

    If you run OmeniaClaw as a service account or want custom paths:

    • OmeniaClaw_HOME — home directory for internal path resolution
    • OmeniaClaw_STATE_DIR — override the state directory
    • OmeniaClaw_CONFIG_PATH — override the config file path

    Full reference: Environment variables.

    Was this useful?
    On this page

    On this page