Install with Cargo

Orchard is written in Rust, so if you already have the Rust toolchain you can build and install the CLI from source with one command. This is a good fit if you want to track the exact compiler you build with.

Install the CLI

$cargo install --git https://github.com/Artemis-Inc/Orchard orch-cli

Cargo compiles the orch binary and puts it in ~/.cargo/bin, which is already on your PATH if you installed Rust with rustup. Check it with orch --version.

Don’t have Rust yet?

Install the toolchain with rustup from rustup.rs, then run the command above.

Use the library

If you want to embed Orchard in a Rust program rather than use the CLI, add the orchard crate to your project instead, and call the library directly. The other platforms page covers embedding in Rust, C, Python, and the browser.

Upgrade and remove

  • Upgrade by running the install command again with --force.
  • Remove with cargo uninstall orch-cli.