Skip to content

First Run ​

Starting the Bot ​

bash
uv run zero-ichi

Optional: run interactive setup before first launch:

bash
uv run zero-ichi setup

CLI Arguments ​

You can run the bot with flags:

bash
uv run zero-ichi --debug --auto-reload
ArgumentDescriptionExample
--debugEnable debug logginguv run zero-ichi --debug
--qrForce QR login modeuv run zero-ichi --qr
--phone NUMBERForce pair-code login with phone numberuv run zero-ichi --phone 6281234567890
--session NAMEOverride session nameuv run zero-ichi --session mybot
--auto-reloadEnable auto-reload for developmentuv run zero-ichi --auto-reload
--dashboardEnable dashboard API at startupuv run zero-ichi --dashboard

CLI Subcommands ​

SubcommandDescriptionExample
setupInteractive setup wizard (configures common settings)uv run zero-ichi setup
updatePull latest code and sync dependenciesuv run zero-ichi update

Update Command ​

Use built-in update command:

bash
uv run zero-ichi update

Setup Wizard Command ​

Use built-in interactive setup wizard:

bash
uv run zero-ichi setup

The wizard guides common first-run settings:

  • session name (used for .session file)
  • login method (QR or pair-code) + phone number
  • owner JID
  • command prefix
  • auto-read / auto-react / self mode
  • dashboard on/off
  • anti-link on/off + action
  • anti-spam on/off + action
  • anti-spam thresholds
  • AI on/off + API key
  • AI provider/model/trigger mode/owner-only
  • rate-limit controls

QR Code Login ​

On first launch, the bot will display a QR code in the terminal:

  1. Open WhatsApp on your phone
  2. Go to Settings → Linked Devices → Link a Device
  3. Scan the QR code displayed in the terminal

INFO

The session is saved to a .session file so you only need to scan once. Subsequent launches will auto-connect.

What Happens Next ​

Once connected, the bot will:

  1. Load all commands — you'll see OK | Loaded 66 commands
  2. Start the scheduler — for reminders and scheduled tasks
  3. Start the dashboard API — on http://localhost:8000 (if enabled)
  4. Begin listening — ready to process messages
20:36:31 INFO  | Message cache database initialized (WAL mode)
20:36:31  ->   | Validating environment...
20:36:31  OK   | Environment validation complete.
20:36:31  ->   | Starting bot...
               | * Session: zero_ichi_bot
               | * Login Method: QR
20:36:31  OK   | Loaded 66 commands
20:36:31  OK   | Bot is running! Press Ctrl+C to stop.

Setting Yourself as Owner ​

Send this message from your WhatsApp:

/config owner me

Or set owner during CLI setup with uv run zero-ichi setup.

If owner is not configured yet, you can also bootstrap owner from a private chat using:

/config owner me

or:

/setup owner me

This gives you access to owner-only commands like /eval, /config, and /addcommand.

Testing Commands ​

Try these commands to verify everything works:

CommandWhat It Does
/pingCheck if the bot is responding
/helpSee all available commands
/uptimeCheck how long the bot has been running
/statsView bot statistics

Next Steps ​

Built with ❤️