Getting Started

Overview

DeepMove is a smart contract development toolchain for Move Developers. You can learn more about the rationale behind the project in the Why DeepMove section.

Automatic Installation

For new projects, it is recommended to set up your DeepMove app using the create-deepmove command line interface (CLI). This will create a new DeepMove project with Move Smart Contracts and TypeScript and install the required dependencies.

pnpm

pnpm create deepmove@latest

npm

npm create deepmove@latest

yarn

yarn create deepmove@latest

bun

bun create deepmove@latest

Once the command runs, you'll see some prompts to complete.

? Project name:  deepmove_project
? Choose the project template:  A simple coin contract
? Choose the chain:  sui

[1/3] Copying files...
[2/3] Installing dependencies...

After the prompts, create-deepmove will create a directory with your project name and install the required dependencies. Check out the README.md for further instructions (if required).

Manual Installation

To manually add DeepMove to your Move project, you can use deepmove interactive client's init command.

simply type command init

sui@deepmove>init
[1/3] Copying files...
[2/3] Update Move dependencies...
Initialized empty Git repository in E:/projects/deepmove/hello/deps/sui/.git/
From https://github.com/MystenLabs/sui
 * branch            framework/testnet -> FETCH_HEAD
 * [new branch]      framework/testnet -> origin/framework/testnet
Switched to a new branch 'framework/testnet'
[3/3] Installing Npm dependencies...