README.md

Symbol CLI

Command Line Interface (CLI) to interact with Symbol.

NOTE: Symbol-CLI is designed to help developers test solutions and interact with Symbol networks quickly from the command line prompt. To hold MAIN NET assets, refer to the Symbol Desktop Wallet project.

Important Notes

• 0.24.x - 0.10.0.6 (Pre-Launch)
• 0.23.x - 0.10.0.x Milestone
• 0.22.x - 0.10.0.x Milestone
• 0.21.x - 0.9.6.3 Milestone
• 0.20.x - 0.9.5.1 Milestone

0.24.x breaks compatibility with HD account derivation in profiles (Testnet) saved using previous versions of the software. Before installing symbol-cli@0.24.x, backup and delete the file ~ \.symbolrc.json.

Find the complete release notes here.

Requirements

• Node.js 12 LTS

Installation

The Symbol CLI is distributed using the node package manager npm.

npm install -g symbol-cli

Usage

Surf the documentation to get started into Symbol development. You will find self-paced guides and useful code snippets using the Symbol CLI.

To get the full list of available commands, check the CLI reference.

Getting help

• Symbol Documentation
• Symbol CLI Reference
• Join the community slack group (#sig-client)
• If you found a bug, open a new issue

Contributing

Contributions are welcome and appreciated. Check CONTRIBUTING for information on how to contribute.

License

Copyright 2018-present NEM

Licensed under the Apache License 2.0