quartz-rs

Crates.io	quartz-rs
lib.rs	quartz-rs
version	0.1.0
source	src
created_at	2024-09-25 21:02:08.785178
updated_at	2024-10-17 13:35:17.166292
description	A CLI tool to streamline development and deployment of Quartz applications. Quartz is a flexible framework for privacy-preserving computation via Trusted Execution Environments (TEEs) organized and secured by smart contracts.
homepage	https://cycles.money
repository	https://github.com/informalsystems/cycles-quartz
max_upload_size
id	1386662
size	256,858

Shoaib Ahmed (hu55a1n1)

documentation

README

quartz CLI

A CLI tool to manage Quartz applications. The quartz CLI tool is designed to streamline the development and deployment process of Quartz applications.

It provides helpful information about each command and its options. To get a list of all available subcommands and their descriptions, use the --help flag:

$ quartz --help

Quartz 0.1.0
A CLI tool to manage Quartz applications

USAGE:
    quartz [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    init        Create base Quartz app directory from template
    build       Build the contract and enclave binaries
    enclave     Enclave subcommads to configure Gramine, build, sign, and start the enclave binary
    contract    Contract subcommads to build, deploy the WASM binary to the blockchain and call instantiate
    handshake   Run the handshake between the contract and enclave

Installation

To install Quartz, ensure you have Rust and Cargo installed. Then run:

cargo install quartz-rs

Usage

See the getting started.

Run quartz init to copy the example app into a new directory. Quartz apps are organized like:

myapp/
├── contracts/
├── enclave/
├── frontend/
└── README.md