Loading...
Loading...
Manage Motoko projects with the mops CLI — toolchain pinning, dependency management, type-checking, building, and linting. Use when working with mops.toml, mops.lock, running mops commands, adding/removing packages, pinning moc or lintoko versions, checking or building canisters, configuring moc flags, or setting up a new Motoko project.
npx skill4agent add dfinity/icskills mops-clidfxmops toolchain initmoc-wrappermops watch --generate--deploymoc[toolchain]mocpocket-ic--check-deploymops toolchain use pocket-ic 15.0.0MOPS_POCKET_IC_URLmo:basemo:coreimport Array "mo:core/Array"mops.toml[canisters]mops check[canisters]mops check src/**/*.momops.toml[toolchain]
moc = "1.15.1"
lintoko = "0.11.0"
pocket-ic = "15.0.0" # required for replica tests / benchmarks / --check-deploy
[dependencies]
core = "2.6.1"
[moc]
args = ["--default-persistent-actors", "-W=M0223,M0236,M0237"]
[canisters.backend]
main = "src/backend/main.mo"
[canisters.backend.migrations]
chain = "src/backend/migrations"
# check-limit = 10 # optional — speeds up `mops check` when the chain gets long
[canisters.backend.check-stable]
path = "deployed/backend.most"
[build]
outputDir = "src/backend/dist"
args = ["--release"]
# check-wasm = true # optional: analyze final Wasm complexity
# check-deploy = true # optional: verify fresh PocketIC installation after build
# Opt-in Wasm optimization (Binaryen wasm-opt) for build + bench
[optimize]
# level = "O3" # default
# keep-names = true # default
# wasm-opt pin: [toolchain] wasm-opt = "131" (required when [optimize] is set)check-stablemops check.most.mostmops deployed initmops deployedmops deployed.mostmops deployedcandidinitArg-W=M0223,M0236,M0237-W=[moc].args[build].args--release[canisters.<name>.migrations]--enhanced-migration[canisters.<name>].args-- <flags>mops checkmops buildmops check-stablemops generatemops migratemops testmops benchmops installmops install # dev flow: keeps mops.lock in sync, self-heals a broken one
mops install --locked # CI flow: fail if mops.lock is missing or would changemops.tomlmops.lock--lockmops.tomlmops installdeps--lockedmops buildmops checkmops check-stablemops check-candidmops testmops benchmops generate candidmops test --lockedmops sources--lockedmops install --lockedCImops.lockpathmops.tomlmops install--lockedmops installpath--lockedpath{MOPS_ENV}path$MOPS_ENVlocalMOPS_ENVmops install--lockedMOPS_ENV--lockedMOPS_ENV--lockedmops install.mops/mops verifymops.lockmops.lockmops.lockmops install --concurrency <n>MOPS_CONCURRENCYfetch failedECONNRESETEMFILEMOPS_CONCURRENCY=1mops verifymops verify # re-hash .mops/ against mops.lock, and mops.lock against the registrymops install.mops/mops add <package>mops add core # latest version
mops add core@2.5.0 # specific version
mops add --dev test # dev dependency
mops add org/repo # GitHub shorthand (also accepts a full github.com url)
mops add ./pkg # local package directorymops.tomlmops.lock<pkg>@<version>"core@1.0.0" = "1.0.0"mops check[migrations]M0267M0254[migrations]check-stable.most[canisters.<name>.check-stable].pathmops check-stable <baseline.most>.momops deployedmops check # all canisters
mops check backend # single canister
mops check --fix # autofix + check + stable + lint
mops check --no-lint # skip the lint step for one run
mops check --verbose # show moc invocations
mops check -- -Werror # treat warnings as errorsmops.toml--fix--fix.mops/fix.lockmops buildmops build # all canisters
mops build backend # single canister
mops build --verbose # show compiler commands
mops build --check-wasm # analyze final Wasm complexity without PocketIC
mops build --no-check-wasm # skip configured [build].check-wasm once
mops build --check-deploy # verify fresh installation on PocketIC
mops build --no-check-deploy # skip configured [build].check-deploy once
mops build -- --ai-errors # pass extra moc flags.wasm.did.most[build].outputDir.mops/.build[optimize]mops.tomlwasm-opt-O3 -gmops toolchain use wasm-opt 131wasm-opt--no-optimizebuildbenchmops.toml--check-wasm[build].check-wasm = trueMOPS-WASM-COMPLEXITY--no-check-wasmmops deployed.mostcheck-stablemops deployed init backend # one-time bootstrap: empty-actor baseline + sets [check-stable].path
mops deployed backend # post-deploy: promotes .mops/.build/backend.most → deployed/backend.most
mops deployed # all canistersdeployed/<name>.most[deployed].dirmops.toml--dir.most[build].outputDir.mops/.build--build-dirmops deployed.mostmops generate candidmops generate candid # all canisters
mops generate candid backend # single canister
mops generate candid backend -o <path> # single canister, ad-hoc path.did[canisters.<name>].candid<name>.didmainmain = "src/Backend.mo"src/backend.did[canisters.<name>].candidmops.toml.didmops.tomlmops buildmops buildmops toolchainmops toolchain use moc 1.15.1 # pin specific version
mops toolchain use moc latest # pin latest version (non-interactive)
mops toolchain use lintoko 0.11.0 # pin specific version
mops toolchain use pocket-ic 15.0.0 # pin for replica tests / benchmarks / --check-deploy
mops toolchain use wasm-opt 131 # Binaryen for [optimize] (or `latest`)
mops toolchain update moc # update to latest (requires existing [toolchain] entry)
mops toolchain update # update all tools to latest
mops toolchain info <tool> # show release info (latest, pinned, history)
mops toolchain info <tool> --versions # list recent releases, newest first
mops toolchain info <tool> --versions --all # full release history (cache warming)
mops toolchain info <tool> --versions --prerelease # include prereleases
mops toolchain bin moc # print path to binarypocket-ic9.0.0latest9.0.0mops bench--check-deploymops toolchain bin pocket-icmops toolchain use pocket-ic 15.0.0toolchain use <tool>latestlatest--versions--prereleasetoolchain update[toolchain]toolchain info <tool> --versionsmops.toml--all[canisters.<name>.migrations]mops checkmops buildmops check-stable--enhanced-migration--enhanced-migration[canisters.<name>].argschainmops check --fixmops check <canister>mops buildmops build --check-deploy[build].check-deploy = true[toolchain] pocket-ic9.0.0MOPS_POCKET_IC_URLmops toolchain use pocket-ic 15.0.0--no-check-deployinitArg()wasmMemoryLimitmoc --stable-compatible.most.mostMOPS-CHECK-DEPLOY-SKIPPEDcheck-limitmops checkmops lintmops buildcheck-limit[canisters.<name>.check-stable].path--stable-baselineM0268check-limitmops check.migrations-<canister>/chain.gitignoremocchaincheck-limit--no-check-limitmops checkmops check-stablemops lintmops check --fix --no-check-limitmops checkmops check-stable--no-check-limitcheck-limitmops check-stablemops checkmocmops remove <package>mops remove core--dev[dev-dependencies]mops outdated # list outdated deps (caret-bound); exit 1 if any, 2 if the check failed
mops outdated core # check a single package
mops update # rewrite mops.toml versions within caret bound (no major-version crossing)
mops update core # update specific package within caret bound
mops update --major # allow updates that cross major versions
mops update --patch # restrict to patch bumps only (mutually exclusive with --major)
mops update --verbose # verbose output
mops sync # add missing / remove unused packages
mops sync --dry-run # print what would change, write nothingmops updatemops.tomlcargo upgradecargo updatemops outdated2mops.tomlmops sync[toolchain] mocmoc --print-depstesttestsbenchbenchmark[dev-dependencies]mops self update-gmopsic-mopsnpm i -D ic-mops@<version>mops publishmops publish # publish to the registry (runs tests/docs/bench by default)
mops publish --dry-run # same local steps as publish; no registry contact / identity
mops publish --dry-run --no-test --no-docs --no-bench # packaging checks only
mops publish --no-test --no-docs --no-bench--dry-run--no-*mops testtest/*.test.momops test # run all tests
mops test my-test # filter by name
mops test --mode wasi # use wasmtime (for to_candid/from_candid)
mops test --reporter files # one line per file (default is verbose)
mops test --watch # re-run on file changes
mops test -- -Werror # pass extra moc flags// @testmode replicapocket-ic[toolchain]MOPS_POCKET_IC_URLmops toolchain use pocket-ic 15.0.0mops benchmops watch --test--replicamops benchbench/*.bench.momops bench # run all benchmarks
mops bench my-bench # filter by name
mops bench --gc incremental # select GC
mops bench --save # save results to .bench/<name>.json
mops bench --compare # compare with saved results
mops bench -- -Werror # pass extra moc flagsmops lintmops checkmops lint # lint all .mo files
mops lint --fix # autofix lint issues
mops lint <name> # filter to .mo files matching <name>[canisters.<name>.migrations].check-limitmops lintmocmops checkmops lint OldMigrationName--no-check-limitmops formatmops format # format all .mo files
mops format --check # check formatting without modifyingmops watchmops watch # errors + warnings + format (the default set)
mops watch --warning # errors + warnings only
mops watch -t # errors + tests-w-f-t--generate--deployargs[canisters.backend]
main = "src/backend/main.mo"
args = ["-A=M0198"]mops init -y
mops toolchain use moc latest # pin latest moc (non-interactive)
mops toolchain use lintoko latest # pin latest lintoko
mops add core[moc].args[canisters][build]mops.tomlmops toolchain update mocmops toolchain update