Skip to content

Commit 7cf16a3

Browse files
snthCopilot
andcommitted
docs: update installation instructions to reference prqlc-cli
The CLI was extracted into the separate prqlc-cli crate. Update: - prqlc/prqlc/README.md: cargo install now references prqlc-cli, intro and CLI section clarify that the CLI is a separate crate - web/website/content/_index.md: crates.io link and cargo install command updated to prqlc-cli Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0810cac commit 7cf16a3

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

prqlc/prqlc/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# PRQL compiler
22

33
`prqlc` is the reference implementation of a compiler from PRQL to SQL, written
4-
in Rust. It also serves as the CLI.
4+
in Rust. The CLI is provided by the separate
5+
[`prqlc-cli`](https://crates.io/crates/prqlc-cli) crate (binary name remains
6+
`prqlc`).
57

68
For more on PRQL, check out the [PRQL website](https://prql-lang.org) or the
79
[PRQL repo](https://github.com/PRQL/prql).
810

911
## CLI
1012

11-
`prqlc` serves as a CLI for the PRQL compiler. It is a single, dependency-free
12-
binary that compiles PRQL into SQL.
13+
The CLI is provided by the [`prqlc-cli`](https://crates.io/crates/prqlc-cli)
14+
crate. It is a single, dependency-free binary that compiles PRQL into SQL.
1315

1416
## Usage
1517

@@ -97,12 +99,12 @@ Precompiled binaries are available for Linux, macOS, and Windows on the
9799

98100
```sh
99101
# From crates.io
100-
cargo install prqlc
102+
cargo install prqlc-cli
101103
```
102104

103105
```sh
104106
# From a local PRQL repository
105-
cargo install --path prqlc/prqlc
107+
cargo install --path prqlc/prqlc-cli
106108
```
107109

108110
### Shell completions

web/website/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,12 @@ tools_section:
153153
154154
`pip install pyprql`
155155
156-
- link: https://crates.io/crates/prqlc
156+
- link: https://crates.io/crates/prqlc-cli
157157
label: "prqlc"
158158
text: |
159159
A CLI for PRQL compiler, written in Rust.
160160
161-
`cargo install prqlc`
161+
`cargo install prqlc-cli`
162162
163163
`brew install prqlc`
164164

0 commit comments

Comments
 (0)