@ivaniscoding/celq-linux-arm64 0.1.1 → 0.1.2-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -11
- package/bin/celq +0 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -35,14 +35,27 @@ Moreover, the CEL specification is simpler than the jqlang specification. If you
|
|
|
35
35
|
|
|
36
36
|
### Pre-built Binaries
|
|
37
37
|
|
|
38
|
-
We publish pre-built binaries in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases).
|
|
38
|
+
We publish pre-built binaries for Linux, macOS, and Windows in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases). To install the current version for Linux or macOS, run:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | bash
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Notice that the installer tries not to be clever and doesn't modify `$PATH` or overwrite existing files. To specify a destination, use the `--to` flag:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | \
|
|
48
|
+
bash -s -- --to DESTINATION
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
See the the [installation guide](https://docs.rs/celq/latest/celq/) for more details on the installer such as `--force` to replace existing binaries, `--target` to specify which binary to download, versioned URLs, GitHub tokens, and more.
|
|
39
52
|
|
|
40
53
|
### Homebrew (macOS)
|
|
41
54
|
|
|
42
55
|
If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq with:
|
|
43
56
|
|
|
44
57
|
```bash
|
|
45
|
-
brew install
|
|
58
|
+
brew install get-celq/tap/celq
|
|
46
59
|
```
|
|
47
60
|
#### Installing From Source
|
|
48
61
|
|
|
@@ -81,7 +94,7 @@ Node.js users can install celq in their project with:
|
|
|
81
94
|
npm install celq
|
|
82
95
|
```
|
|
83
96
|
|
|
84
|
-
This adds celq to `package.json` and makes it available for scripts. It's also possible to run single commands with:
|
|
97
|
+
This adds celq to `package.json` and makes it available for scripts. It's also possible to run single commands with [npx](https://docs.npmjs.com/cli/v8/commands/npx):
|
|
85
98
|
|
|
86
99
|
```bash
|
|
87
100
|
npx celq -n '"Hello World"'
|
|
@@ -89,18 +102,18 @@ npx celq -n '"Hello World"'
|
|
|
89
102
|
|
|
90
103
|
## Limitations
|
|
91
104
|
|
|
92
|
-
### CEL Implementation Differences
|
|
93
|
-
|
|
94
|
-
`celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation.
|
|
95
|
-
|
|
96
|
-
While `cel-rust` provides excellent compatibility with the CEL specification, there may be edge cases or advanced features where behavior differs from the official implementation. If you find one, feel free to report it at their repository.
|
|
97
|
-
|
|
98
105
|
### JSON Parsing
|
|
99
106
|
|
|
100
107
|
`celq` eagerly parses all JSON input into memory before evaluation. This design was made to simplify the code implementation, at the cost of memory and performance.
|
|
101
108
|
|
|
102
109
|
Currently, there are no benchmarks for `celq`. I believe the tool is "good enough" for my personal use. That might be revisited in the future. In the meantime, expect `celq` to be slower than `jq`.
|
|
103
110
|
|
|
111
|
+
### CEL Implementation Differences
|
|
112
|
+
|
|
113
|
+
`celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation.
|
|
114
|
+
|
|
115
|
+
While `cel-rust` provides excellent compatibility with the CEL specification, there may be edge cases or advanced features where behavior differs from the official implementation. If you find one, feel free to report it at their repository.
|
|
116
|
+
|
|
104
117
|
### List and Map Arguments
|
|
105
118
|
|
|
106
119
|
Currently, the `--arg` syntax only supports `int`, `bool`, `float`, and `string`. Support for other CEL types will be added in the future.
|
|
@@ -111,9 +124,9 @@ Currently, the `--arg` syntax only supports `int`, `bool`, `float`, and `string`
|
|
|
111
124
|
|
|
112
125
|
While conceptually interesting, `celq` does not aim to be a CEL REPL. In the original author's view, that should live on a separate binary.
|
|
113
126
|
|
|
114
|
-
### YAML Support
|
|
127
|
+
### Full YAML Support
|
|
115
128
|
|
|
116
|
-
`celq` works with JSON.
|
|
129
|
+
`celq` works with JSON. YAML will be supported in the future as a best-effort. Full YAML support is out-of-scope, as the specification has too many edge cases.
|
|
117
130
|
|
|
118
131
|
## Acknowledgments
|
|
119
132
|
|
|
@@ -132,6 +145,8 @@ All the documentation in the manual has been hand-crafted. That was done to keep
|
|
|
132
145
|
|
|
133
146
|
This project is dual-licensed under the MIT License and Apache 2.0 licenses. See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) file for details.
|
|
134
147
|
|
|
148
|
+
The `install.sh` published with each GitHub release and its template at the root of the repository (`template_install.sh`) are licensed independently. Those files are under the CC0-1.0 license. They are the original work of Casey Rodarmor from [just](https://github.com/casey/just) and have been adapted for celq.
|
|
149
|
+
|
|
135
150
|
## Contributing
|
|
136
151
|
|
|
137
152
|
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
|
package/bin/celq
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -15,11 +15,11 @@
|
|
|
15
15
|
],
|
|
16
16
|
"publishConfig": {
|
|
17
17
|
"access": "public",
|
|
18
|
-
"tag": "
|
|
18
|
+
"tag": "prerelease"
|
|
19
19
|
},
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|
|
22
22
|
"url": "git+https://github.com/IvanIsCoding/celq.git"
|
|
23
23
|
},
|
|
24
|
-
"version": "0.1.1"
|
|
24
|
+
"version": "0.1.2-alpha.1"
|
|
25
25
|
}
|