Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 2.81 KB

README.md

File metadata and controls

107 lines (69 loc) · 2.81 KB

Gevulot Control CLI

This tool is used to interact with Gevulot Network.

Installation

Pre-built releases

You can download pre-built release binaries from releases:

Supported platforms:

  • x86_64-unknown-linux-gnu
  • x86_64-apple-darwin
  • aarch64-apple-darwin

Installation of pre-built release

  1. Download archive

    curl -fLO https://github.com/gevulotnetwork/gvltctl/releases/download/${VERSION}/gvltctl-${PLATFORM}.tar.gz

  2. (Optional) Verify checksum

    curl -fLO https://github.com/gevulotnetwork/gvltctl/releases/download/${VERSION}/gvltctl-${PLATFORM}.tar.gz.sha256
sha256sum -c gvltctl-${PLATFORM}.tar.gz.sha256

  3. Install the binary

      tar xf gvltctl-${PLATFORM}.tar.gz
  cp gvltctl-${PLATFORM}/gvltctl $HOME/.local/bin

Compiling from sources

To compile gvltclt crate you will need following dependencies:

cargo install --git https://github.com/gevulotnetwork/gvltctl.git --tag $VERSION

Runtime dependencies

To use gvltctl install following dependencies:

  • ca-certificates

gvltctl build

gvltctl build needs additional dependencies.

To operate on containers:

  • podman or docker (see --container-backend option)

To build Linux kernel from sources (not needed if using pre-compiled kernel with --kernel-file):

  • git build-essential libncurses-dev gawk flex bison openssl libssl-dev dkms libelf-dev libudev-dev libpci-dev libiberty-dev autoconf llvm bc

To operate on VM filesystem:

  • e2fsprogs

To mount VM filesystem using FUSE (see --fuse option):

  • fuse2fs

Usage

$ gvltctl --help
Gevulot Control CLI

Usage: gvltctl <COMMAND>

Commands:
  worker               Commands related to workers
  pin                  Commands related to pins
  task                 Commands related to tasks
  workflow             Commands related to workflows
  keygen               Generate a new key
  compute-key          Compute a key
  send                 Send tokens to a receiver on the Gevulot network
  account-info         Get the balance of the given account
  generate-completion  Generate shell completion scripts
  sudo                 Perform administrative operations with sudo privileges
  build                Build a VM image from a container, rootfs directory, or Containerfile
  help                 Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Supported platforms

gvltctl is supported on both Linux and MacOS (Windows is not tested, but probably also works).

Building Linux VM (gvltctl build) is only supported on Linux right now.