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

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.89](https://img.shields.io/badge/rustc-1.89+-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.
 
@@ -23,19 +23,24 @@ Popular configuration formats such as JSON5, YAML, and TOML are supported. The c
 
 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), [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.
 
+Check our [comparison with other tools](https://docs.rs/celq/latest/celq/comparison_with_other_tools) for more details.
+
 ## Installation
 
 ### 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 +53,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/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, 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)
 
@@ -108,7 +113,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
@@ -145,6 +150,32 @@ If you are going to use `celq` in scripts or for multiple calls, we recommend us
     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
+VERSION=v0.2.0
+RELEASE_URL=https://github.com/IvanIsCoding/celq/releases/download/${VERSION}
+
+fetch ${RELEASE_URL}/celq-freebsd-x86_64.tar.gz
+
+tar xzf celq-freebsd-x86_64.tar.gz
+su root -c 'install -m 755 celq /usr/local/bin/'
+```
+
+`celq` can also be installed from source following the [Cargo](#cargo) section. We strive to always compile with the Rust version provided in the ports tree.
+
 ## Limitations
 
 ### Eager JSON Parsing
@@ -163,6 +194,10 @@ There may be edge cases or advanced features where behavior differs from the off
 
 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
@@ -179,6 +214,7 @@ Special thanks to the maintainers of:
 - **[cel-rust](https://github.com/cel-rust/cel-rust)** for providing the CEL evaluation engine that powers `celq`
 - **[cel-python](https://github.com/cloud-custodian/cel-python)** for publishing their CLI. `celq` has heavily drawn from their interface
 - **[jaq](https://github.com/01mf02/jaq)** for giving an excellent blueprint on how to test a Rust CLI
+- **[gron](https://github.com/tomnomnom/gron)** for greppable JSON
 
 ## Large Language Models Disclosure
 
@@ -195,3 +231,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

@@ -15,11 +15,11 @@
   ],
   "publishConfig": {
     "access": "public",
-    "tag": "prerelease"
+    "tag": "latest"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/IvanIsCoding/celq.git"
   },
-  "version": "0.2.0-alpha.1"
+  "version": "0.2.0"
 }