Mycelium CLI — init, newwallet, compile, deploy, register
Project description
Mycelium CLI
The Mycelium CLI (mycelium command-line tool) is the developer command center for the Mycelium framework. It provides interactive scaffolding, local wallet/keypair management, contract checking and compilation, Soroban blockchain deployments, agent directory registration in the Hive registry, and execution runners for autonomous agent loops.
🚀 Installation & Setup
Install the CLI toolchain directly from PyPI (packaged within mycelium-cli or bundled inside the parent mycelium-stellar wrapper):
pip install mycelium-cli
Verify that the installation was successful by running:
mycelium --help
⚙️ Configuration Reference (mycelium.toml)
All Mycelium CLI operations run relative to a project root containing a mycelium.toml file. This configuration serves as the single source of truth for the local agent and its corresponding on-chain contract.
[project]
name = "sentinel_agent"
version = "0.1.0"
author = "Developer"
[agent]
framework = "gemini" # Options: "langgraph" | "gemini" | "anthropic" | "custom"
model = "gemini-2.0-flash" # Target LLM model string
unique_name = "sentinel_alpha" # Alphanumeric agent registry name
[onchain]
source_contract = "contract.py" # Path to smart contract source file
target_wasm = "build/contract.wasm" # Output binary path
network = "testnet" # Default ledger target: "testnet" | "mainnet"
contract_id = "CC..." # Automatically populated after deployment
wallet_public_key = "GD..." # Automatically populated after deployment
[registry]
hive_registry_address = "CCQ..." # Hex contract address of the Hive Registry
service_endpoint = "https://agent.sentinel.mycelium.sh" # Agent API URL
capabilities = ["data-analysis", "stellar-arbitrage"] # List of capability tags
🛠️ Complete CLI Command Reference
1. mycelium init
Scaffolds a new Mycelium project from scratch. It launches an interactive setup wizard that prompts you for project properties.
- Syntax:
mycelium init <project_name> [options]
- Interactive Wizard Options:
- AI Core Framework: Select from
langgraph,gemini,anthropic, orcustom. - Target LLM Model: Pick from recommended defaults or input a custom string.
- Unique Name: Choose a registry name (regex validated against
^[a-zA-Z0-9_]{3,30}$).
- AI Core Framework: Select from
- Flags:
--yes/-y: Skip all interactive questions and initialize using standard default configurations.--force/-f: Overwrite the destination directory if it already exists.
2. mycelium newwallet
Generates a new secure Stellar keypair (Ed25519) and saves it to .mycelium/wallet.json.
- Syntax:
mycelium newwallet [options]
- Security Details:
- The secret seed is encrypted at rest using PBKDF2-HMAC-SHA256 (600,000 iterations) + AES-256-GCM.
- Prompts securely for an encryption passphrase.
- Filesystem permissions on
.mycelium/wallet.jsonare automatically restricted to0600(read/write by owner only).
- Flags:
--passphrase <text>: Provide the encryption passphrase directly (convenient for automated environments).--force: Force generation, overwriting any existing wallet configuration.
3. mycelium compile
Parses and compiles a Python-DSL contract file into a WebAssembly contract binary.
- Syntax:
mycelium compile [source_file] [options]
- Flags:
--output <path>/-o <path>: Specify the output WASM file path (defaults tobuild/contract.wasm).--optimize: Enable maximum optimization passes (release profile, targeting size reduction).
4. mycelium check
Performs static evaluation and type verification on a contract script without generating a WASM binary. Useful for checking syntax in IDEs, git pre-commit hooks, or CI pipelines.
- Syntax:
mycelium check [source_file]
5. mycelium deploy
Deploys the compiled WASM binary directly to Stellar/Soroban.
- Syntax:
mycelium deploy [options]
- Behaviors:
- Testnet: Checks the balance. If the balance is zero, the CLI automatically requests funds from the Stellar Friendbot API, waits for ledger confirmation, and broadcasts the deployment transaction.
- Mainnet: Asserts the wallet has a minimum balance of
5 XLM(to satisfy reserves). If insufficient, it halts with an error and displays the public key. - On success, updates
contract_idandwallet_public_keyinmycelium.toml.
- Flags:
--network <name>: Override the network target (testnetormainnet).--wasm <path>: Override the WASM file path to deploy.
6. mycelium register
Submits a signed transaction to the global Hive Registry mapping your agent's configuration parameters.
- Syntax:
mycelium register [options]
- Details:
- Packages the agent name, service endpoint, public address, and the SHA-256 hash of capability tags.
- Verifies that local keys match the owner keys if updating an existing registration.
7. mycelium status
Displays the comprehensive deployment and configuration status of the active project in a single screen.
- Syntax:
mycelium status - Output Fields:
- Wallet Address: G-address extracted from local wallet config.
- Wallet Balance: Balance retrieved from Horizon RPC.
- Network: Deployed target network passphrase identifier.
- Contract Deployment: Verification status of the contract ID on the ledger.
- Registry Entry: Name verification, registration state, reputation score, and API endpoint details.
8. mycelium fund
Explicitly requests Friendbot funding for the agent's wallet. Used to top up testnet gas balances.
- Syntax:
mycelium fund [options]
- Flags:
--amount <number>: Request a specific amount (if supported by network node limits).
9. mycelium call
Invokes an on-chain contract function directly from your terminal.
- Syntax:
mycelium call <function_name> [args...] [options]
- Details:
- Automatically maps plain argument strings to the correct Soroban type based on the contract specification.
- Flags:
--read-only: Execute as a simulate-only view invocation (free, does not require passphrase or signature).--contract <id>: Override the target contract ID.
10. mycelium resolve
Queries the on-chain Hive Registry to resolve details of another agent by its name.
- Syntax:
mycelium resolve <agent_name>
11. mycelium pay
Triggers an agent-to-agent XLM settlement payment. It resolves the destination agent's wallet address from the registry.
- Syntax:
mycelium pay <recipient_name_or_address> <amount_xlm>
12. mycelium events / mycelium logs
Streams on-chain event topics emitted by the agent's smart contract.
- Syntax:
mycelium events [options]
- Flags:
--contract <id>: Override the contract ID to monitor.--start-ledger <number>: Begin streaming historical events from a specific ledger sequence.
13. mycelium doctor
Runs a suite of sanity checks to verify the state of your local toolchain:
- Asserts
stellar-cliis present on your system path. - Checks if local cargo/wasm targets are properly configured.
- Tests network connectivity and latency to Horizon and Soroban RPC nodes.
- Identifies version mismatches and prints corrective shell actions.
- Syntax:
mycelium doctor
14. mycelium run
Spins up the agent's execution loop (agent.py) in your terminal, pre-loading context configurations, wallet files, and contract IDs from the project directory.
- Syntax:
mycelium run [options]
- Flags:
--steps <number>: Limit the maximum number of steps the LLM loop is permitted to run.
15. mycelium test
Performs a simulation dry-run of the agent loop. It intercepts all state-changing contract calls, executes them via simulation, logs estimated resource fees, and returns without signing or broadcasting transactions.
- Syntax:
mycelium test
🔐 Environment Variables
MYCELIUM_DECRYPT_KEY: Set this env variable to bypass interactive wallet decryption password prompts. Essential for CI/CD and non-interactive workflows.MYCELIUM_CONTRACT_ID: Override default contract target.STELLAR_NETWORK: Overrides default network selection (testnet/mainnet).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mycelium_cli-0.1.0.tar.gz.
File metadata
- Download URL: mycelium_cli-0.1.0.tar.gz
- Upload date:
- Size: 28.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd929d0332bc31f1c16ebbdebc18f2cf682bd515dce773a873f9c41cc3a65412
|
|
| MD5 |
ab66b847a7833969afb9eca9528076a7
|
|
| BLAKE2b-256 |
1982653c7c168650075bef27a1586a8dcd5efede776dfb3c909dd78cbe6a542d
|
File details
Details for the file mycelium_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mycelium_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 33.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e944a37dbf31a4227eb30a13df7ba5f28d24f725d2f4cff99524989cf27fb9d8
|
|
| MD5 |
6bdd2edb3521d6d610d7921832fc2179
|
|
| BLAKE2b-256 |
515353eb8afbca0cd3ea13ca5c77665d13fca61c9fe794dfdd1d20eb529ad675
|