Plasma CLI

Maven Central Version

The Plasma CLI is a command line interface to the Plasma platform.

It is a simple tool to interact with the Plasma platform.

The documentation is in progress and will be linked soon.

For developers

How to run Integration test:

Run your desired version of the node in your local, plasma-node/releases

docker run -it -p 9084:9084 ghcr.io/plasmalaboratories/plasma-node:x.y.x

> sbt:plasma-cli-umbrella> integration/test
> [info] Passed: Total 25, Failed 0, Errors 0, Passed 25
> [success] Total time: 482 s (08:02), completed Nov 26, 2024, 11:44:44 AM

How to assembly and run the cli

sbt:plasma-cli-umbrella> cli/assembly
[info] Built: .../plasma-cli/cli/target/scala-3.3.4/plasmacli.jar
[info] Jar hash: ccbb9c1c0f2822b0be78c5c5d8680721d456a16e
[success] Total time: 14 s, completed Dec 5, 2024, 5:46:41 PM


➜  ✗ java -jar ./cli/target/scala-3.3.4/plasmacli.jar    
Invalid mode, try 'help' for more information
➜  ✗ java -jar ./cli/target/scala-3.3.4/plasmacli.jar help
Usage:  [help]

Command: help
Welcome to Plasma-Cli
Valid modes are:
   - templates: Template mode
   - fellowships: Fellowship mode
   - indexer-query: Indexer query mode
   - node-query: Node query mode
   - wallet: Wallet mode
   - tx: Transaction mode
   - simple-transaction: Simple transaction mode
   - simple-minting: Simple minting mode
   - server: Server mode