Skip to content

Getting Started

Requirements

  • Python 3.11+
  • Node.js 20+ (WhatsApp bridge)
  • Linux/macOS/Windows

For platform-specific paths, see Install Matrix.

Install

git clone https://github.com/galyarderlabs/galyarder-agent.git
cd galyarder-agent/backend/agent
pip install -e .

First run

g-agent onboard
g-agent status

onboard is safe to re-run — it merges new defaults into your existing config without overwriting customizations like API keys.

Start runtime

g-agent gateway

Channel login

g-agent channels login

Use Telegram/WhatsApp after login and allowlist setup.

Use service templates in backend/agent/deploy/systemd/ and run as user units.

For day-to-day operations and diagnostics, see Operations.

For in-app Python usage, see Embedding.