Skip to content

Commit 53d48ae

Browse files
authored
docs: update cli docs for duckdb instructions (#821)
Closes #820
1 parent ba9e461 commit 53d48ae

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

crates/cli/README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@ Command Line Interface (CLI) for [STAC](https://stacspec.org/), named `rustac`.
1010

1111
## Installation
1212

13+
If you have DuckDB on your system:
14+
15+
```sh
16+
cargo install rustac
17+
```
18+
19+
> [!TIP]
20+
> Set `DUCKDB_LIB_DIR` to the directory containing your **libduckdb**.
21+
> If you're on macos and using [Homebrew](https://brew.sh/), this might be `export DUCKDB_LIB_DIR=/opt/homebrew/lib`
22+
23+
Otherwise:
24+
1325
```sh
14-
cargo install rustac -F duckdb # to use libduckdb on your system
15-
# or
16-
cargo install rustac -F duckdb-bundled # to build libduckdb on install (slow)
26+
cargo install rustac -F duckdb-bundled # (slow)
1727
```
1828

1929
Then:
@@ -55,17 +65,6 @@ $ rustac validate item.json
5565

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

58-
## Features
59-
60-
This crate has three features:
61-
62-
- `pgstac`: enable a [pgstac](https://github.com/stac-utils/pgstac) backend for `rustac serve`
63-
- `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)
64-
- `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)
65-
66-
> [!TIP]
67-
> 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`
68-
6968
## Other info
7069

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

0 commit comments

Comments
 (0)