Getting Started

This section covers everything you need to start building automation functions on Mimic Protocol. It is organized into two skills that you can work through in order.

---

What you need

• Node.js 18 or later

• A package manager: npm, yarn, or pnpm

• A Mimic account and API key — get one from the Mimic explorer under account settings

---

The two skills

Skill	What you will learn
CLI	Install and use the Mimic CLI to scaffold, build, and deploy functions
Writing a Mimic Function	Understand the function anatomy, library APIs, intents, queries, logging, and persistent storage

---

Development workflow at a glance

npx @mimicprotocol/cli init my-function   # scaffold project
cd my-function
yarn mimic codegen                         # generate types from manifest
# ... write your function logic ...
yarn mimic compile                         # compile to WASM
yarn mimic deploy                          # upload to IPFS registry

After deploying, open the explorer, find your function, create a trigger, and sign it with your wallet. Relayers will pick it up and execute it automatically.

---

Next steps

• CLI skill — start here if you are new to the toolchain

• Function skill — learn how to write function logic using the library

• Examples — end-to-end walkthroughs for common automation patterns