Skip to content

Commit d9e9bed

Browse files
committed
Update installation guide
1 parent 76e89be commit d9e9bed

2 files changed

Lines changed: 98 additions & 2 deletions

File tree

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,59 @@ Moreover, the CEL specification is simpler than the jqlang specification. If you
3333

3434
## Installation
3535

36+
### Pre-built Binaries
37+
38+
We publish pre-built binaries in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases).
39+
40+
### Homebrew (macOS)
41+
42+
If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq with:
43+
44+
```bash
45+
brew install IvanIsCoding/tap/celq
46+
```
47+
#### Installing From Source
48+
49+
If you want to install from source, celq publishes to [crates.io](https://crates.io/crates/celq).
50+
3651
```bash
3752
cargo install celq
3853
```
3954

40-
This installs `celq` from source. In the future, pre-built binaries will be provided.
55+
#### Installing With cargo-binstall
56+
57+
If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) installed, you can install pre-built binaries directly:
58+
59+
```bash
60+
cargo binstall celq
61+
```
62+
63+
### Python
64+
65+
celq is packaged for [PyPI](https://pypi.org/project/celq/). Python users can install it with `pip`:
66+
67+
```bash
68+
pip install celq
69+
```
70+
71+
If you have [uv](https://github.com/astral-sh/uv) installed, `celq` can be used as a tool:
72+
```bash
73+
uvx celq -n '"Hello World"'
74+
```
75+
76+
### NPM (Node.js/JavaScript)
77+
78+
Node.js users can install celq in their project with:
79+
80+
```bash
81+
npm install celq
82+
```
83+
84+
This adds celq to `package.json` and makes it available for scripts. It's also possible to run single commands with:
85+
86+
```bash
87+
npx celq -n '"Hello World"'
88+
```
4189

4290
## Limitations
4391

docs/manual.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,60 @@
22

33
## Installation
44

5-
### From source
5+
### Pre-built Binaries
6+
7+
We publish pre-built binaries in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases).
8+
9+
### Homebrew (macOS)
10+
11+
If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq with:
12+
13+
```bash
14+
brew install IvanIsCoding/tap/celq
15+
```
16+
#### Installing From Source
17+
18+
If you want to install from source, celq publishes to [crates.io](https://crates.io/crates/celq).
619

720
```bash
821
cargo install celq
922
```
1023

24+
#### Installing With cargo-binstall
25+
26+
If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) installed, you can install pre-built binaries directly:
27+
28+
```bash
29+
cargo binstall celq
30+
```
31+
32+
### Python
33+
34+
celq is packaged for [PyPI](https://pypi.org/project/celq/). Python users can install it with `pip`:
35+
36+
```bash
37+
pip install celq
38+
```
39+
40+
If you have [uv](https://github.com/astral-sh/uv) installed, `celq` can be used as a tool:
41+
```bash
42+
uvx celq -n '"Hello World"'
43+
```
44+
45+
### NPM (Node.js/JavaScript)
46+
47+
Node.js users can install celq in their project with:
48+
49+
```bash
50+
npm install celq
51+
```
52+
53+
This adds celq to `package.json` and makes it available for scripts. It's also possible to run single commands with:
54+
55+
```bash
56+
npx celq -n '"Hello World"'
57+
```
58+
1159
## Overview
1260

1361
```none

0 commit comments

Comments
 (0)