Skip to content

docs: update cli docs for duckdb instructions #821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gadomski merged 1 commit into from
Oct 21, 2025
Merged

docs: update cli docs for duckdb instructions #821

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions crates/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,20 @@ Command Line Interface (CLI) for [STAC](https://stacspec.org/), named `rustac`.

## Installation

If you have DuckDB on your system:

```sh
cargo install rustac
```

> [!TIP]
> Set `DUCKDB_LIB_DIR` to the directory containing your **libduckdb**.
> If you're on macos and using [Homebrew](https://brew.sh/), this might be `export DUCKDB_LIB_DIR=/opt/homebrew/lib`

Otherwise:

```sh
cargo install rustac -F duckdb # to use libduckdb on your system
# or
cargo install rustac -F duckdb-bundled # to build libduckdb on install (slow)
cargo install rustac -F duckdb-bundled # (slow)
```

Then:
Expand Down Expand Up @@ -55,17 +65,6 @@ $ rustac validate item.json

Use the `--help` flag to see all available options for the CLI and the subcommands:

## Features

This crate has three features:

- `pgstac`: enable a [pgstac](https://github.com/stac-utils/pgstac) backend for `rustac serve`
- `duckdb`: build with DuckDB support, which enables searching [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet) (requires DuckDB to be present on your system)
- `duckdb-bundled`: bundle DuckDB by building it from source, instead of using a local installation (does _not_ require DuckDB to be present on your system)

> [!TIP]
> If you're using the `duckdb` feature, set `DUCKDB_LIB_DIR` to the directory containing your **libduckdb**. If you're on macos and using [Homebrew](https://brew.sh/), this might be `export DUCKDB_LIB_DIR=/opt/homebrew/lib`

## Other info

This crate is part of the [rustac](https://github.com/stac-utils/rustac) monorepo, see its README for contributing and license information.
Loading