# Mops

Mops is a package manager for the Motoko programming language.

- [Motoko Package Registry](https://mops.one)
- [Documentation](https://docs.mops.one)
- [Blog](https://blog.mops.one)
- [CLI](https://cli.mops.one)

## Setup

### 1. Check system requirements
- [Node.js](https://nodejs.org/) >= 22.0.0

Mops downloads and manages the Motoko toolchain itself. It does not need `dfx`, and does not support it.

### 2. Install CLI tool
```
curl -fsSL cli.mops.one/install.sh | sh
```
or
```
npm i -g ic-mops
```

## Install Packages

### 1. Initialize
Run this command in the root directory of your project

```
mops init
```

### 2. Pin the Motoko compiler
Every command that compiles uses the `moc` pinned in `mops.toml`

```
mops toolchain use moc latest
```

### 3. Install Motoko Packages
Use `mops add <package_name>` to install a specific package and save it to `mops.toml`

```
mops add core
```

You can also add packages from GitHub like this
```
mops add https://github.com/dfinity/motoko-base
```

For GitHub-packages you can specify branch, tag, or commit hash by adding `#<branch/tag/hash>`
```
mops add https://github.com/dfinity/motoko-base#moc-0.9.1
```

You can also add local packages like this (put source files inside `src` directory)
```
mops add ./shared
```

Use `mops install` to install all packages specified in `mops.toml`
```
mops install
```

### 4. Import Package
Now you can import installed packages in your Motoko code

```motoko
import PackageName "mo:<package_name>";
```
for example
```motoko
import Itertools "mo:itertools/Iter";
```

## Publish a Package

### 1. Import Identity
Import an existing secp256k1 or Ed25519 private key into `mops`

```
mops user import -- "$(icp identity export mops)"
```

### 2. Initialize
Run this command in your package root and select type "Package"

```
mops init
```

Edit `description` and `repository` fields in `mops.toml` file.

Write your package code in `*.mo` source files in the `src/` directory.

Create `README.md` file with information on how to use your package.

### 3. Publish
Publish package to the mops registry!

```
mops publish
```

------------
*Built for the [Supernova Hackathon](https://dfinity.org/supernova/)*