onboard command allows you to configure multiple settings of your agent at once, including your inference provider, LLM, tunnels, and channels. It provides a guided experience to help you set up your agent in minutes.
If you haven’t set up your agent yet, follow our Quickstart guide
If you are new to IronClaw, we recommend you to configure channels, tools, and other settings one at a time instead of
all at once through the
onboard command.Onboarding Wizard
If you are new to IronClaw, we recommend you to configure channels, tools, and other settings one at a time instead of all at once through the onboard command.Start the Onboarding Wizard
To start the onboarding wizard, run the following command in your terminal:
Select the Database Path
The wizard will first ask you to select a path for the agent’s database, by default
/home/agent/.ironclaw/ironclaw.db. This is where the agent will store your configuration.Secrets Management
Choose were to store your master secrets key, which is used to encrypt all your credentials.The recommended option is to use the system’s keyring, but if you are running in an environment without a keyring (like a server or a container), prefer to store the master key in an environment variable
Inference Provider and LLM
Built-in providers include Anthropic, OpenAI, Google Gemini, MiniMax, Mistral, and Ollama (local).We recommend using NEAR AI as your inference provider for maximum privacy and security, and the
Qwen3-30B model to start for its cost-effectiveness.Enable Semantics
Embeddings enable semantic search in your workspace memory, we recommend enabling it.
Configure Tunnel & Channels
Tunnels are used to securely expose your agent’s API to the internet, which is required for channels to work. We recommend using ngrok for its ease of use and reliability.After configuring your tunnel, you can select which channels you want to enable for your agent, so it can listen and respond to messages from, for example, Telegram, Slack, or Discord.You can always add more channels later.
Tools / Extensions
You can configure which tools and extensions you want to enable for your agent. They are used by the agent to perform actions, like searching the web, reading and sending emails, using github, and more.You can always add more tools and extensions later.
Docker Sandboxing
IronClaw can execute code, run builds, and use tools inside Docker
containers. This keeps your system safe — commands from the LLM run
in an isolated sandbox with no access to your credentials, limited
filesystem access, and network traffic restricted to an allowlist.
If you are running IronClaw in an environment without Docker (like a server or a container), you can disable sandboxing