Lightweight OLAS mech runtime
Project description
micromech
A lightweight mech for the OLAS network. micromech runs an autonomous AI agent (called a "mech") that listens for on-chain requests, solves them using pluggable tools, and delivers results back on-chain.
No prior experience with OLAS or blockchain development is needed to get started.
What You Need
- A computer that can stay on (or a cheap cloud server). 2 GB RAM minimum.
- Docker Desktop — a free app that runs micromech in an isolated container.
- An internet connection.
After installing Docker Desktop, open it once and make sure it's running (you'll see a whale icon in your system tray or menu bar).
Install & Run
Mac / Linux
Open Terminal and paste this command:
bash <(curl -sSL https://raw.githubusercontent.com/dvilelaf/micromech/main/scripts/quickstart.sh)
Windows
Open a WSL terminal (search "WSL" in the Start menu) and paste the same command:
bash <(curl -sSL https://raw.githubusercontent.com/dvilelaf/micromech/main/scripts/quickstart.sh)
If WSL is not installed, open PowerShell as Administrator and run
wsl --install, then restart your computer. Docker Desktop must be set to use the WSL 2 backend (this is the default).
Then start micromech:
cd micromech
docker compose up -d
Open http://localhost:8090 in your browser. You should see the micromech dashboard.
First-Time Setup
The dashboard at http://localhost:8090 walks you through a setup wizard:
Step 1 — Create your wallet. This is your on-chain identity. Pick a strong password. micromech stores your wallet locally — nobody else has access to it.
Step 2 — Choose your chains. Chains are different blockchain networks. Gnosis is the default and cheapest to start with. You can add more later.
Step 3 — Fund your wallet. Your wallet needs a small amount of cryptocurrency to pay for transaction fees (like postage stamps for the blockchain). The wizard shows your wallet address and tells you exactly how much you need.
Step 4 — Deploy your mech. Hit the deploy button. micromech registers your AI worker on the OLAS network. This takes a minute or two.
Step 5 — Start earning. Once deployed, micromech automatically listens for AI requests, solves them, and collects rewards. There is nothing else to do.
Is It Working?
Visit http://localhost:8090 at any time. You're in good shape if you see:
- Status: Running — your mech is online and listening for requests
- Deliveries increasing over time — your mech is solving tasks
- Rewards accumulating — you're earning OLAS tokens
It's normal for deliveries to come in waves. Some hours are busier than others.
Remote Control via Telegram (Optional)
Control your mech from your phone:
- Open Telegram, search for @BotFather, send
/newbotand follow the prompts. Copy the token it gives you. - Search for @userinfobot, send it any message. Copy your chat ID (a number).
- Open
micromech/secrets.envin any text editor and fill in:telegram_token=your-bot-token-here telegram_chat_id=your-chat-id-here - Restart:
cd micromech && docker compose restart
Now send /status to your bot to check on your mech.
Day-to-Day Commands
Run these from inside the micromech/ folder:
| Command | What it does |
|---|---|
docker compose up -d |
Start micromech |
docker compose down |
Stop micromech |
docker compose logs -f micromech |
View live logs (Ctrl+C to exit) |
docker compose pull && docker compose up -d |
Update to latest version |
micromech restarts automatically if your computer reboots.
Your Files
After the quickstart, your micromech/ folder contains:
| File | What it is | Notes |
|---|---|---|
secrets.env |
Passwords, API keys, Telegram token, custom RPC endpoints | Never share. This is the main file you'll edit. |
docker-compose.yml |
Docker configuration | Leave it alone unless you need to change ports. |
data/ |
All persistent data (wallet, database, config, AI models) | Back this up regularly. |
data/micromech.yaml |
Mech settings (created after first setup) | You can edit it, but the web dashboard is easier. |
data/wallet.json |
Your encrypted wallet | Never share. Back this up. |
data/mech.db |
Request history database | Grows over time. No need to touch it. |
updater.sh |
Auto-update script | Don't touch. |
Justfile |
Command shortcuts (requires just) |
Optional convenience, safe to ignore. |
Backup reminder: Copy the entire
data/folder somewhere safe. If you losedata/wallet.json, you lose access to your wallet.
FAQ
"Docker is not running" Open the Docker Desktop app. Wait until the whale icon stops animating.
"Port 8090 already in use"
Edit docker-compose.yml and change 127.0.0.1:8090:8090 to 127.0.0.1:8001:8090, then open http://localhost:8001.
"I closed the terminal and it stopped"
Make sure you started with docker compose up -d (the -d flag makes it run in the background).
"How much can I earn?" Depends on network demand. Check staking.olas.network for current rates.
"Is my wallet safe?"
Your private key is encrypted with your password and stored only on your machine in micromech/data/. Back up this folder.
"How do I uninstall?"
Run docker compose down then delete the micromech/ folder.
Glossary
| Term | What it means |
|---|---|
| Mech | An AI worker on the blockchain that answers requests for a fee |
| OLAS | The token (cryptocurrency) you earn as rewards |
| Staking | Locking tokens to prove you're a reliable worker — micromech handles this |
| Checkpoint | Periodic on-chain proof your mech is active — called automatically |
| Delivery | A completed AI task your mech solved |
| Tool | An AI capability (text generation, prediction, etc.) |
| Chain | A blockchain network (Gnosis, Ethereum, etc.) |
| Gas | A small fee for blockchain transactions, like postage |
For Developers
git clone https://github.com/dvilelaf/micromech
cd micromech && uv sync --all-extras
just check # lint + types
just security # gitleaks + bandit
just test # pytest
License
Apache-2.0
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 micromech-0.0.5.tar.gz.
File metadata
- Download URL: micromech-0.0.5.tar.gz
- Upload date:
- Size: 5.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ba797c32dafbbc9652c15d4e9eca1f787003a06cfb3ac041421ec840519c895
|
|
| MD5 |
f2af046a893bc5e8dfbf95ca808a8187
|
|
| BLAKE2b-256 |
2f5baf21c34a890005e18b379c9ed5333e4322e54f679ff0c0c03ee1575f3dff
|
File details
Details for the file micromech-0.0.5-py3-none-any.whl.
File metadata
- Download URL: micromech-0.0.5-py3-none-any.whl
- Upload date:
- Size: 2.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b31a5071cc167f80d7ca1e4e0512d81b49ef205786612a8f8777c9336cf8cf8
|
|
| MD5 |
997ee9bc98af3dddca095bcd00f6d315
|
|
| BLAKE2b-256 |
8d7e50b7c5343a3ad1bed7bcd97d9e1c5871e5bc714a5322b330172b00da307b
|