Installation

Lectito provides both a CLI tool and a Rust library. Install whichever fits your needs.

CLI Installation

From crates.io

The easiest way to install the CLI is via cargo:

cargo install lectito-cli

This installs the lectito binary in your cargo bin directory (typically ~/.cargo/bin).

From Source

# Clone the repository
git clone https://github.com/stormlightlabs/lectito.git
cd lectito

# Build and install
cargo install --path crates/cli

Pre-built Binaries

Pre-built binaries are available on the GitHub Releases page for Linux, macOS, and Windows.

Download the appropriate binary for your platform and place it in your PATH.

Verify Installation

lectito --version

You should see version information printed.

Library Installation

Add to your Cargo.toml:

[dependencies]
lectito-core = "0.1"

Then run cargo build to fetch and compile the dependency.

Feature Flags

The library has several optional features:

[dependencies]
lectito-core = { version = "0.1", features = ["fetch", "markdown"] }
FeatureDefaultDescription
fetchYesEnable URL fetching with reqwest
markdownYesEnable Markdown output format
siteconfigYesEnable site configuration support

If you don't need URL fetching (e.g., you have your own HTTP client), disable the default features:

[dependencies]
lectito-core = { version = "0.1", default-features = false, features = ["markdown"] }

Development Build

To build from source for development:

# Clone the repository
git clone https://github.com/stormlightlabs/lectito.git
cd lectito

# Build the workspace
cargo build --release

# The CLI binary will be at target/release/lectito

Next Steps