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

package/README.md

@@ -19,13 +19,13 @@ 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/).
 
 ## 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.
 
@@ -35,21 +35,54 @@ Moreover, the CEL specification is simpler than the jqlang specification. If you
 
 ### Pre-built Binaries
 
-We publish pre-built binaries in celq's [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases).
+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:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | bash
+```
+
+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:
+
+```bash
+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.
 
 ### Homebrew (macOS)
 
 If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq with:
 
 ```bash
-brew install IvanIsCoding/tap/celq
+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
@@ -81,26 +114,51 @@ Node.js users can install celq in their project with:
 npm install celq
 ```
 
-This adds celq to `package.json` and makes it available for scripts. It's also possible to run single commands with:
+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):
 
 ```bash
 npx celq -n '"Hello World"'
 ```
 
-## Limitations
+### GitHub Actions
 
-### CEL Implementation Differences
+`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:
 
-`celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation. 
+```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):
 
-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.
+```yaml
+- uses: taiki-e/install-action@v2
+  with:
+    tool: celq
+```
+
+## 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.
 
 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`.
 
+### CEL Implementation Differences
+
+`celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation. 
+
+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.
@@ -111,9 +169,9 @@ Currently, the `--arg` syntax only supports `int`, `bool`, `float`, and `string`
 
 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.
 
-### YAML Support
+### Full YAML Support
 
-`celq` works with JSON. I originally considered supporting YAML as a supported input format. However, the amount of YAML edge cases pushed me back to JSON. Although that might change in the future, please do not open an issue asking for YAML support as of today.
+`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
 
@@ -132,6 +190,8 @@ All the documentation in the manual has been hand-crafted. That was done to keep
 
 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.
 
+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.
+
 ## Contributing
 
 Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

package/package.json

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