dfinity / motoko-dev-server

A live reload development server for Motoko smart contracts.

mo-dev  

A live reload development server for Motoko smart contracts.

---

mo-dev is a flexible command-line tool for speeding up your Motoko development workflow.

• Announcement blog post
• Developer forum topic

Try Online

Get started with a full-stack Vite + React + Motoko project directly in your browser:

Quick Start

Run the following command (requires Node.js ≥ 16):

npm i -g mo-dev

Note: standalone mo-dev binaries are also available as GitHub releases.

Once installed, view the available command-line options by passing the --help flag:

mo-dev --help

Check out the Vite + React + Motoko starter project for an example of how to integrate mo-dev into a modern full-stack webapp.

Basic Features

Regenerate type declarations on Motoko file change (--generate or -g):

mo-dev --generate

Deploy canisters on Motoko file change (--deploy or -d):

mo-dev --deploy

Automatically respond "yes" to reinstall prompts (--yes or -y; may clear canister state):

mo-dev --deploy -y

Run unit tests (*.test.mo) on Motoko file change (--test or -t):

mo-dev --test

Run an arbitrary command on Motoko file change (--exec or -x):

mo-dev --exec 'npm run my-reload-script'

Specify the working directory (--cwd or -C; should contain a dfx.json file):

mo-dev --cwd path/to/dfx_project

Only run the dev server for specific canisters (--canister or -c):

mo-dev --canister foo --canister bar --deploy

Pass an installation argument to dfx deploy (--argument or -a):

mo-dev --deploy --argument '()'

Advanced Features

Show additional debug output in the console (--verbose or -v):

mo-dev -v # more verbose
mo-dev -vv # extra verbose

Programmatically start mo-dev using JavaScript:

import devServer from 'mo-dev';

// Default settings
devServer();

// Custom settings
devServer({
    directory: '.',
    port: 7700,
    verbosity: 0,
    // ...
});

mo-test

The mo-dev npm package includes a mo-test command which can be used to run unit tests in CI workflows.

View all available options:

mo-test --help

Run all Motoko unit tests (*.test.mo):

mo-test

Run all Motoko unit tests using a WASI runtime by default (faster but requires installing Wasmtime on your system):

mo-test --testmode wasi

Configure the runtime of an individual unit test by including the following comment in a *.test.mo file:

// @testmode wasi

Run specific unit tests by passing a file name prefix (-f or --testfile):

mo-test -f Foo -f Bar # (only run tests for files starting with `Foo` or `Bar`)

These options may also be passed directly into the mo-dev command (e.g. mo-dev --testmode wasi -f SomeTest).

---

mo-dev is early in development. Please feel free to report a bug, ask a question, or request a feature on the project's GitHub issues page.

Contributions are welcome! Please check out the contributor guidelines for more information.

motoko-dev-server's Issues

Possible to specify which canisters to run a given command?

Hello, thanks for the very useful project.

Is it possible to pass commands to mo-dev so that only specific canisters are included?

For instance, mo-dev generate will also generate the declarations for the internet_identity canister that's declared in the dfx.json but whose declarations are not needed (similarly they will be generated for a frontend canister).

provide install arguments for canisters

it seems like there is no way to provide install arguments for canisters, can this be added?

Contribute example projects and templates

• Vite: https://github.com/vitejs/awesome-vite (reference: Vite + React + Motoko example project)
• Create React App: https://github.com/tuchk4/awesome-create-react-app (reference: Motoko Playground)
• Next.js: https://github.com/vercel/next.js/tree/canary/examples
• Motoko (standalone): https://github.com/motoko-unofficial/awesome-motoko

port 4943 HARDCODED?!?!

how to make it work with a port other than 4943 specified in ~/.config/dfx/networks.json?