Skip to content

asimov-modules/asimov-jq-module

Repository files navigation

ASIMOV JQ Module

License Package on Crates.io Package on PyPI Package on RubyGems Package on NPM Documentation

ASIMOV module for JSON transformation using the jq filter language.

✨ Features

  • Transforms JSON inputs using the jq programming language.
  • Supports values from environment variables using the env.USER syntax.
  • Loads environment variables from .env (aka dotenv) files.
  • Distributed as a standalone static binary with zero runtime dependencies.

🛠️ Prerequisites

  • Rust 1.85+ (2024 edition) if building from source code

⬇️ Installation

Installation with the ASIMOV CLI

asimov module install jq -v

Installation with the ASIMOV CLI

Installation from PyPI

pip install -U asimov-jq-module

Installation from RubyGems

gem install asimov-jq-module

Installation from NPM

npm install -g asimov-jq-module

Installation from Source Code

cargo install asimov-jq-module

👉 Examples

JSON Transformation

asimov-jq-runner filter.jq < input.json > output.json

⚙ Configuration

This module requires no configuration.

📚 Reference

Installed Binaries

  • asimov-jq-runner: filters JSON from standard input to standard output

asimov-jq-runner

asimov-jq-runner

Usage: asimov-jq-runner [OPTIONS] <FILTER>

Arguments:
  <FILTER>  The `.jq` filter file to execute

Options:
  -d, --debug       Enable debugging output
      --license     Show license information
  -v, --verbose...  Enable verbose output (may be repeated for more verbosity)
  -V, --version     Print version information
  -h, --help        Print help

👨‍💻 Development

git clone https://github.com/asimov-modules/asimov-jq-module.git

Share on X Share on Reddit Share on Hacker News Share on Facebook Share on LinkedIn

About

✅ ASIMOV module for JSON transformation using the jq filter language.

Topics

Resources

License

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Contributors