@ivaniscoding/celq-linux-arm64 0.1.2-alpha.1 → 0.2.0-beta.1

package/README.md

@@ -1,5 +1,5 @@
 # celq
- [![Crates.io](https://img.shields.io/crates/v/celq.svg)](https://crates.io/crates/celq) [![Documentation](https://docs.rs/celq/badge.svg)](https://docs.rs/celq) [![Minimum rustc 1.90](https://img.shields.io/badge/rustc-1.90+-blue.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html)
+ [![Crates.io](https://img.shields.io/crates/v/celq.svg)](https://crates.io/crates/celq) [![Documentation](https://docs.rs/celq/badge.svg)](https://docs.rs/celq) [![Playground](https://img.shields.io/badge/playground-live-brightgreen)](https://celq-playground.github.io/) [![Minimum rustc 1.90](https://img.shields.io/badge/rustc-1.90+-blue.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html) 
 
 **celq** is a command-line tool for evaluating [Common Expression Language (CEL)](https://cel.dev/) expressions. It processes JSON input, performs computations, and outputs results. Think of it as if [jq](https://jqlang.org/) supported CEL.
 
@@ -19,15 +19,18 @@ celq -n --arg='fruit:string=apple' 'fruit.contains("a")'
 # Outputs: true
 ```
 
-Closely related formats such as NDJSON and JSON5 are also supported.
+Popular configuration formats such as JSON5, YAML, and TOML are supported. The closely related format NDJSON is also supported.
 
 For detailed usage examples and recipes, see the [manual](https://docs.rs/celq/latest/celq/).
 
+### Interactive Playground
+Want to try `celq` without installing anything? Visit the [celq-playground](https://celq-playground.github.io/) to try it in your browser!
+
 ## Why?
 
-There are implementations of CEL for [Go](https://github.com/google/cel-go), [C++](https://github.com/google/cel-cpp), [Python](https://github.com/cloud-custodian/cel-python), [JavaScript](https://github.com/marcbachmann/cel-js), [Rust](https://github.com/cel-rust/cel-rust), and possibly more languages.
+There are implementations of CEL for [Go](https://github.com/google/cel-go), [Java](https://github.com/google/cel-java), [C++](https://github.com/google/cel-cpp), [JavaScript](https://github.com/marcbachmann/cel-js), [Python](https://github.com/cloud-custodian/cel-python), [C#](https://github.com/telus-oss/cel-net), [Rust](https://github.com/cel-rust/cel-rust), [Ruby](https://gitlab.com/os85/cel-ruby), and possibly more languages.
 
-`celq` brings the same CEL syntax to the command-line. `celq` is not necessarily better than jq, but perhaps it makes it easier to reuse snippets of code accross multiple places.
+`celq` brings the same CEL syntax to the command-line. `celq` is not necessarily better than jq, but perhaps it makes it easier to reuse snippets of code across multiple places.
 
 Moreover, the CEL specification is simpler than the jqlang specification. If you need something less powerful than `jq` or Python, then `celq` might be what you are looking for.
 
@@ -35,7 +38,7 @@ Moreover, the CEL specification is simpler than the jqlang specification. If you
 
 ### Pre-built Binaries
 
-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:
+We publish pre-built binaries for Linux, macOS, FreeBSD, and Windows in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases). To install the current version for Linux or macOS, run:
 
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | bash
@@ -48,7 +51,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | \
     bash -s -- --to DESTINATION
 ```
 
-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.
+See the [installation guide](https://docs.rs/celq/latest/celq/installation_guide) for more details on the installer such as `--force` to replace existing binaries, `--target` to specify which binary to download, versioned URLs, GitHub tokens, attestations, and more.
 
 ### Homebrew (macOS)
 
@@ -57,12 +60,32 @@ If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq
 ```bash
 brew install get-celq/tap/celq
 ```
+
+### Chocolatey (Windows)
+
+If you are a [Chocolatey](https://community.chocolatey.org/) user on Windows, you can install `celq` with:
+
+```bash
+choco install celq
+```
+
+### Scoop (Windows)
+
+If you are a [Scoop](https://scoop.sh/) user on Windows, you can install `celq` with:
+
+```bash
+scoop bucket add get-celq https://github.com/get-celq/scoop-bucket
+scoop install get-celq/celq
+```
+
+### Cargo
+
 #### Installing From Source 
 
 If you want to install from source, celq publishes to [crates.io](https://crates.io/crates/celq).
 
 ```bash
-cargo install celq
+cargo install celq --locked
 ```
 
 #### Installing With cargo-binstall
@@ -88,7 +111,7 @@ uvx celq -n '"Hello World"'
 
 ### NPM (Node.js/JavaScript)
 
-Node.js users can install celq in their project with:
+`celq` is packaged for [NPM](https://www.npmjs.com/package/celq). Node.js users can install celq in their project with:
 
 ```bash
 npm install celq
@@ -100,9 +123,65 @@ This adds celq to `package.json` and makes it available for scripts. It's also p
 npx celq -n '"Hello World"'
 ```
 
+### GitHub Actions
+
+`celq` can be used in GitHub actions. For one-off commands, the [get-celq/celq-action](https://github.com/get-celq/celq-action) is the quickest way:
+
+```yaml
+- name: Example Celq Action
+  id: exampleID
+  uses: get-celq/celq-action@main
+  with:
+    cmd: celq 'this.exampleID' < example.json
+
+- name: Reuse a variable obtained in another step
+  run: echo ${{ steps.exampleID.outputs.result }}
+```
+
+See the [installation guide](https://docs.rs/celq/latest/celq/installation_guide) for more details on GitHub actions such as pinning the `celq` version and the Action itself.
+
+If you are going to use `celq` in scripts or for multiple calls, we recommend using [taiki-e/install-action](https://github.com/taiki-e/install-action):
+
+```yaml
+- uses: taiki-e/install-action@v2
+  with:
+    tool: celq
+```
+
+### Nix
+
+`celq` is available for [Nix](https://github.com/NixOS/nix). To run it as a Flake:
+
+```bash
+nix run github:IvanIsCoding/celq -- -n '"Hello World"'
+```
+
+See the [installation guide](https://docs.rs/celq/latest/celq/installation_guide) for other Nix setups.
+
+### FreeBSD
+
+FreeBSD builds are tested in [Cirrus CI](https://cirrus-ci.org/) and cross-compiled with [Zig](https://github.com/rust-cross/cargo-zigbuild). Although `celq` is not yet in the ports tree, it does publish pre-built binaries:
+
+```bash
+# Set version
+VERSION=v0.2.0
+RELEASE_URL=https://github.com/IvanIsCoding/celq/releases/download/${VERSION}
+
+# Download and verify checksum
+fetch ${RELEASE_URL}/SHA256SUMS
+fetch ${RELEASE_URL}/celq-x86_64-unknown-freebsd.tar.gz
+sha256 -c SHA256SUMS --ignore-missing
+
+# Extract and install
+tar xzf celq-x86_64-unknown-freebsd.tar.gz
+sudo install -m 755 celq /usr/local/bin/
+```
+
+`celq` can be installed from source following the [Cargo](#cargo) section. We strive to always compile with the Rust version provided in the ports tree.
+
 ## Limitations
 
-### JSON Parsing
+### Eager JSON Parsing
 
 `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.
 
@@ -112,12 +191,16 @@ Currently, there are no benchmarks for `celq`. I believe the tool is "good enoug
 
 `celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation. 
 
-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.
+There may be edge cases or advanced features where behavior differs from the official implementation. If you find one, open an issue at the celq repository and we'll triage the issue before sending it to cel-rust.
 
 ### List and Map Arguments
 
 Currently, the `--arg` syntax only supports `int`, `bool`, `float`, and `string`. Support for other CEL types will be added in the future.
 
+### Malformed expressions
+
+Currently, the error messages for CEL expressions that are invalid are cryptic. We will enhance them in future releases.
+
 ## Non-Goals
 
 ### REPL
@@ -126,7 +209,7 @@ While conceptually interesting, `celq` does not aim to be a CEL REPL. In the ori
 
 ### Full YAML Support
 
-`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.
+`celq` works with JSON. YAML is supported as a best-effort. If the ingested YAML can be translated to JSON, `celq` most likely works fine. Full YAML support is out-of-scope, as the specification has too many edge cases.
 
 ## Acknowledgments
 
@@ -150,3 +233,5 @@ The `install.sh` published with each GitHub release and its template at the root
 ## Contributing
 
 Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+
+Unless explicitly stated otherwise, any contribution intentionally submitted for inclusion in `celq` by you shall be dual-licensed under the [MIT License](LICENSE-MIT) and the [Apache 2.0 license](LICENSE-APACHE). Contributions to `template_install.sh` shall be dedicated to the public domain. Any additional terms or conditions shall not apply.

package/package.json

@@ -21,5 +21,5 @@
     "type": "git",
     "url": "git+https://github.com/IvanIsCoding/celq.git"
   },
-  "version": "0.1.2-alpha.1"
+  "version": "0.2.0-beta.1"
 }