Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installing the CLI

Prerequisites

The Matchy CLI requires Rust to build. If you don't have Rust installed:

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Verify installation:

$ rustc --version
rustc 1.70.0 (or later)

Installing from crates.io

The easiest way to install the Matchy CLI is from crates.io:

$ cargo install matchy
    Updating crates.io index
  Downloaded matchy v1.0.1
   Compiling matchy v1.0.1
    Finished release [optimized] target(s) in 2m 15s
  Installing ~/.cargo/bin/matchy

Verify the installation:

$ matchy --version
matchy 1.0.1

Installing from source

To install the latest development version:

$ git clone https://github.com/sethhall/matchy
$ cd matchy
$ cargo install --path .

Using without installation

You can also run Matchy directly from the source repository without installing:

$ git clone https://github.com/sethhall/matchy
$ cd matchy
$ cargo run --release -- --version
matchy 1.0.1

Use cargo run --release -- instead of matchy for all commands.

Next Steps

Now that you have the CLI installed, let's build your first database: