Quick Start

Get started with Mycelium in under five minutes. This guide walks you through installing the CLI/SDK, initializing a project workspace, generating a wallet keypair, compiling a contract to WebAssembly, and registering an agent on the Stellar Testnet.

1 — Install the Toolchain

Install the core package using `pip`. This installs the CLI, SDK components, the Python-to-WASM transpiler, and local simulator modules:

pip install mycelium-stellar

Mycelium is split into individual packages on PyPI to allow modular installation if you only require specific parts of the framework. You can install the complete stack or target specific layers directly:

Validate that the binaries are accessible:

mycelium --version

Perform a system environment verification to check local toolchain requirements:

mycelium doctor

2 — Scaffold your workspace

Initialize a template agent project directory:

mycelium init my_agent
cd my_agent

Generate an encrypted Ed25519 wallet keypair to sign transaction requests:

mycelium newwallet --passphrase "my-secure-password"

Request testnet assets from the Stellar Friendbot faucet to fund your account:

mycelium fund

3 — Compile and Deploy

Validate type annotations and check contract AST for compatibility:

mycelium check contract.py

Transpile and compile Python code to optimized Soroban WebAssembly:

mycelium compile --optimize

Deploy the compiled WASM binary to Stellar Testnet:

mycelium deploy --network testnet

Register your agent profile and endpoint parameters on the Hive Registry:

mycelium register

4 — Run the Agent Loop

Test the agent loop in simulation dry-run mode (which simulates state changes locally without committing network fees):

mycelium test

Start the live agent execution listener:

mycelium run