Content

The mimic CLI is a command-line interface to:

• Initialize a Mimic-compatible task project
• Generate types from your task manifest and ABIs
• Compile your AssemblyScript tasks to WebAssembly
• Test your tasks
• Deploy compiled tasks to IPFS and the Mimic Registry
• Link tasks to a project in the Mimic explorer

Setup

To set up this project you'll need git and yarn installed.

Install the CLI from the root of the monorepo:

# Clone this repository
$ git clone https://github.com/mimic-protocol/tooling

# Go into the repository
$ cd tooling

# Install dependencies
$ yarn

Usage

Here's a quick overview of common commands:

USAGE
  $ mimic [COMMAND]

COMMANDS
  codegen  Generates typed interfaces for declared inputs and ABIs from your manifest.yaml file
  compile  Compiles task
  test     Tests your tasks
  deploy   Uploads your compiled task artifacts to IPFS and registers it into the Mimic Registry
  init     Initializes a new Mimic-compatible project structure in the specified directory

For full CLI documentation and examples please visit docs.mimic.fi

Security

To read more about our auditing and related security processes please refer to the security section of our docs site.

However, if you found any potential issue in any of our smart contracts or in any piece of code you consider critical for the safety of the protocol, please contact us through [email protected].

License

This project is licensed under the GNU General Public License v3.0.
See the LICENSE file for details.

Third-Party Code

This project includes code from The Graph Tooling, licensed under the MIT License.
See the LICENSE-MIT file for details. Their original license and attribution are preserved.

Website mimic.fi  ·  Docs docs.mimic.fi  ·  GitHub @mimic-fi  ·  Twitter @mimicfi  ·  Discord mimic