cmu create

cmu create scaffolds a new CointMU project and initializes the project directory with a template-selected smart contract workspace.

Usage

cmu create [project] [options]

Arguments

Argument	Description
[project]	The name of the project directory to create. Optional — if omitted, the command prompts for it interactively.

Project name validation rules:

• Only alphanumeric characters, hyphens (-), and underscores (_) are allowed.
• The target directory must not already exist.
• The project path is resolved against the current working directory before generation begins.

If validation fails, the command exits before any files are generated.

Options

Flag	Description	Allowed Values
-t, --template <template>	Select the scaffold template to generate.	blank, erc20, erc721, erc1155, dao, marketplace, staking, airdrop, vault, kyberion
-l, --language <language>	Select the project language for the scaffold.	typescript, javascript

-v, --verbose is available globally; see Global Options.

An unknown template is rejected before anything is written, and the error lists every valid one:

error: create failed
unknown template 'nft'.
hint: choose one of: blank, erc20, erc721, erc1155, dao, marketplace, staking, airdrop, vault, kyberion

Interactive Mode

If [project], --language, or --template is omitted, the command prompts for each missing value using Inquirer.

Prompt order:

1. Project name — if not provided as an argument.
2. Language — if --language is not provided.
3. Template — if --template is not provided.

All values are validated against their respective allowed values before project generation begins.

Available Templates

Template	Description
blank	Minimal project skeleton with the default directory structure and a placeholder deploy script.
erc20	Fungible token project with a standard ERC20 contract and deployment script.
erc721	Non-fungible token project with a standard ERC721 contract and deployment script.
erc1155	Multi-token project with a standard ERC1155 contract and deployment script.
dao	Basic decentralized autonomous organization contract and deployment script.
marketplace	NFT marketplace contract and deployment script.
staking	ERC20 staking and yield farming project.
airdrop	Merkle tree token airdrop project.
vault	Multisig timelock treasury project.
kyberion	Post-quantum cryptography research prototype.

Generated Files

A TypeScript erc20 project, for example:

my-token/
├── .env.example
├── .gitignore
├── artifacts/.gitkeep
├── cmu.config.ts
├── contracts/StandardERC20.sol
├── deploy/01_standarderc20.ts
├── deployments/.gitkeep
├── package.json
├── scripts/.gitkeep
├── test/Template.test.ts
└── tsconfig.json

A JavaScript project has cmu.config.js, a .js deploy script and test, and no tsconfig.json.

The generated cmu.config.ts (cmu.config.js uses module.exports = instead of export default):

export default {
  defaultNetwork: "local",
  networks: {
    local: {
      url: "http://127.0.0.1:8585",
      chainId: 1912,
      symbol: "CMU",
    },
    // Set this to your own CointMU mainnet RPC endpoint before deploying.
    // Keep it on https://: a plaintext http:// endpoint can be intercepted and
    // made to return spoofed chain state (balances, nonces, gas, receipts).
    mainnet: {
      url: "",
      chainId: 1912,
      symbol: "CMU",
    },
  },
  wallet: {
    privateKey: process.env.PRIVATE_KEY,
  },
  compiler: {
    version: "0.8.20",
  },
};

symbol is new in 1.7.0. cmu explorer labels balances with it, and a network without it shows ETH, so a project created by an older cmu needs symbol: "CMU" added by hand. mainnet ships with an empty url; set it before deploying there.

deployments/ is where cmu deploy records each deployed contract, as deployments/<network>/<Contract>.json. The scaffolded deploy script does not write any address file itself.

The generated .gitignore:

# Dependency directories
node_modules/

# Coverage output
coverage/

# Environment files
.env
.env.local
.env.test
.env.production

# CointMU local session & network state (encrypted key / local-only config)
.cmu-session
.cmu-session.*.tmp
.cmu-session.bak-*
.cmu-networks.json
.cmu-wallets.json

# Compiled artifacts
artifacts/
dist/

# Local devnet deployment records (other networks' records are meant to be committed)
deployments/local/

# Logs
logs
*.log
npm-debug.log*

.cmu-session.*.tmp is the temporary file an interrupted session write can leave behind, and .cmu-session.bak-* is the copy cmu wallet use keeps before replacing a session it cannot open. Both hold an encrypted key and are listed since 1.7.1; add them to the .gitignore of a project created earlier.

.cmu-networks.json and .cmu-wallets.json live in your home directory, not the project; they are listed so a copy can never be committed by accident. Only deployments/local/ is ignored: records for shared networks are meant to be committed, so everyone on the project resolves the same addresses.

Dependency Installation

After the files are written, cmu create runs npm install inside the new project directory and installs its baseline dependencies:

Dependency set	Packages
Runtime	ethers
TypeScript dev	@types/node, mocha, chai, @types/mocha, @types/chai, ts-node, typescript@5
JavaScript dev	mocha, chai

Installer output is streamed directly to the terminal, so the command takes noticeably longer than file generation alone.

INFO

Built-in contract templates are self-contained and pull in no Solidity dependencies. Install those separately if you extend a template — see Supported Libraries.

Post-Creation Output

After a successful scaffold, the CLI prints a confirmation banner and the standard next steps:

   ______      _       __  _____  __
  / ____/___  (_)___  / /_/ __  \/ / /
 / /   / __ \/ / __ \/ __/ / / / / / /
/ /___/ /_/ / / / / / /_/ / / / / /_/ /
\____/\____/_/_/ /_/\__/_/ /_/_/\____/

Created CointMU project '<project>'

Next steps:
  1. cd <project>
  2. cmu compile
  3. cmu deploy

TIP

A random motivational quote is printed after each successful project creation.