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

Installation

Open PQL can be used in two ways: as a command-line tool (opql) or as a library embedded in a Rust program.

Requirements

  • Rust 1.85 or newer (edition 2024)
  • A recent cargo toolchain

Install the CLI

Clone the repository and build the runner crate:

git clone https://github.com/solve-poker/Poker-Query-Language.git
cd Poker-Query-Language
cargo install --path openpql-runner

This installs the opql binary into ~/.cargo/bin/. Check it’s on your PATH:

opql --help

Use as a Library

Add the runner crate to your Cargo.toml:

[dependencies]
openpql-runner = "0.1.0"

See Library Usage for integration details.

Build From Source

If you plan to contribute or run tests, clone the workspace and use the provided justfile:

just build      # cargo build
just test       # cargo nextest run
just lint       # cargo clippy
just doc        # cargo doc --no-deps

Next Step

Continue to Your First Query.