Skip to content

modality-org/modality-rust

Repository files navigation

Modality 🦀 + ⲙ

Modality Banner

⚙️ Documentation | 🌟 Examples | 💬 Community


✨ Features

  • 🔑 Generate unique IDs with ease
  • 🔒 Securely manage secret keys
  • 🛠️ Simple and intuitive command-line interface
  • ⚡ Lightweight and fast Rust-based implementation

🎯 Use Cases

  • 🔐 Identity management
  • 📚 Formal Native Verificaiton
  • 🌐 Deploy Verifiable Contracts to Global Network

🚀 Quick Start

Prerequisites

Note for Windows Users: Use Windows Subsystem for Linux (WSL) for the best experience.

Installation

Clone the repository and build the project:

cargo install modality

Basic Commands

Help Command

modality help

Displays all available commands and usage details.


Create a New ID

modality create-id

Generates a unique ID and saves the associated private key securely.

Example Output:

✨ Successfully created a new Modality ID!
📍 Modality ID: 12D3KooWMRAdDAzYKfvPrN1R1Cf5fPC1iSLe37yUDV5FhEWsWABB
🔑 Modality Passkey saved to: ./12D3KooWMRAdDAzYKfvPrN1R1Cf5fPC1iSLe37yUDV5FhEWsWABB.mod_passkey

🚨🚨🚨  IMPORTANT: Keep your passkey file secure and never share it! 🚨🚨🚨

Advanced Usage

Checking Version

modality --version

Prints the current version of the CLI.


🌍 Community & Support


Contributors


Star History

Star History Chart

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published