# Installation

  1. Install the binary with the following bash script.
curl https://raw.githubusercontent.com/zkonduit/ezkl/main/install_ezkl_cli.sh | bash
  1. Alternatively, build from source:
git clone git@github.com:zkonduit/ezkl.git
cd ezkl
cargo install --force --path .

For detailed options, use ezkl --help or ezkl <command> --help.

Install EZKL using pip:

pip install ezkl

You may also need to install additional dependencies:

  • onnx for exporting models
  • PyTorch or TensorFlow for creating models

To use EZKL in your Python code:

import ezkl

Install EZKL using npm:

npm install @ezkljs/engine

To use EZKL in your JavaScript code:

import { Engine } from '@ezkljs/engine';
  1. Install archon with the following script
curl https://download.ezkl.xyz/download_archon.sh | bash
  1. If your system settings block the installed binary you will need to allow your system to run the binary.

  2. Set the server environment variable:

export ARCHON_SERVER_URL="https://archon-v0.ezkl.xyz"
  1. Test the connection:
archon ping

# Additional Notes

  • While there is some support for Windows with the original ezkl repository, unfortunately Lilith does not work on Windows systems.
  • EZKL uses your system's solc Solidity compiler. You may need to adjust it using svm-rs or solc-select.
  • For rendering model circuits with EZKL, compile with the render feature and install required libraries (e.g., libexpat1-dev and libfreetype6-dev on Debian systems).
  • For EZKL Rust documentation, use cargo doc --open.