Skip to main content

Getting Started

Get MushroomAgent up and running on your machine in a few minutes. This guide walks through the shortest supported path from install to a working local agent.

For a first setup, run MushroomAgent as an agent. The agent is the decision side: it receives information, calls the model, decides what action should happen, and can run by itself on one machine.

What you need​

  • Linux or macOS. On Windows, use WSL2 for now.
  • A normal interactive terminal
  • A working LLM API key

Quick setup​

  1. Run the installer

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

    The installer checks your system, installs missing dependencies where possible, downloads MushroomAgent, links the mushroom-agent command, and starts the initialization wizard.

  2. Follow the prompts

    Choose the default agent mode for a local setup, then enter the provider, model, and API key when the wizard asks for them.

  3. Start the agent

    mushroom-agent start

Node mode​

Node mode is for a separate device that should collect input and execute output for an agent running elsewhere.

A node collects information such as voice, video, text, and local device events, then forwards it to the agent. The agent decides what to do and sends actions back to the node. Those actions may be voice output, UI actions, robot movement, or other device-specific behavior.

Use the dedicated node installer only after you already have an agent running and an access key for the node:

curl -fsSL https://docs.kiwilightyear.com/install_node.sh | bash -s -- \
  --server-url ws://server-host:7860 \
  --access-key <accesskey> \
  --node-name "Kitchen Pi"

Then start the node with:

mushroom-agent node attach

Voice mode​

Voice-related configuration can be generated directly by the installer wizard. Choose voice mode when prompted, then start as usual:

mushroom-agent start

What to do next​

Docs hubs

Browse the full documentation by topic.

CLI Reference

Learn about remote mode and multi-device setups.