Skip to content

setup.md

Latest commit

 

History

History
57 lines (42 loc) · 1.58 KB

setup.md

File metadata and controls

57 lines (42 loc) · 1.58 KB

Setup

Punchcard targets Debian and Ubuntu and was validated on Ubuntu 24.04.4 LTS, which is the current system used for this repository.

The repository includes a setup script for host dependencies:

./scripts/setup.sh

Use ./scripts/setup.sh --check when you only want to verify that the host is already ready.

The setup script covers the system packages required for runtime and RAG PDF extraction:

  • ca-certificates
  • curl
  • git
  • build-essential
  • pkg-config
  • libssl-dev
  • poppler-utils

pdftotext comes from poppler-utils and is required for PDF extraction.

Rust 1.91 or newer is still required separately. If cargo, rustc, cargo fmt, or cargo clippy are missing, install Rust with rustup and add the formatter and clippy components.

For the repository workflow after host setup:

./scripts/install-local.sh
punchcard init
./scripts/validate.sh

See Configuration for every .punchcard/config.toml option.

protoc is not required by default because punchcard-rag enables vendored-protoc, which lets Lance build with vendored protobuf tooling. This is portable but slower on clean build directories because protobuf-src compiles protoc.

For faster local builds, install the system compiler and disable the vendored feature:

sudo apt-get install protobuf-compiler
cargo build -p punchcard-rag --no-default-features
cargo build -p punchcard --no-default-features

This changes only build-time protobuf generation for Lance; it does not change Punchcard runtime retrieval behavior or embedding performance.