22 releases (11 breaking)
0.19.2 | Aug 17, 2024 |
---|---|
0.19.1 | Jul 26, 2024 |
0.19.0 | Feb 5, 2024 |
0.18.3 | Dec 24, 2023 |
0.10.0 | Jun 13, 2022 |
#666 in Command line utilities
22 downloads per month
145KB
3K
SLoC
xt
xt is a cross-format translator for JSON, YAML, TOML, and MessagePack.
For example, you can process a set of TOML files with jq
:
$ xt a/Cargo.lock b/Cargo.lock | jq -r '.package[].name' | sort -u
aho-corasick
anes
autocfg
# etc.
Or transform a JSON configuration file into YAML for easier editing:
$ xt -t yaml config.json > config.yaml
Or store an unbounded stream of JSON events as MessagePack to save space:
$ curl localhost:8001/apis/events.k8s.io/v1/events?watch | xt -tm > events.msgpack
Installation
xt is built with Rust, and leverages the powerful Serde ecosystem of data serialization and deserialization libraries.
After installing Rust on your system, you can install xt from crates.io using Cargo:
cargo install --locked xt
NetBSD
On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:
pkgin install xt-rs
Usage and Features
xt [-f format] [-t format] [file ...]
Or, run xt --help
for full usage information.
xt is built to "do one thing well," and tries to maintain a minimal interface
and feature set. The most common options are -t
to specify an output format
other than JSON, and one or more files to read from rather than standard input.
Some of xt's notable features include:
Automatic Format Detection
When the input format is not specified with the -f
option, xt can detect it
automatically by file extension, or by examining the content of the input stream
itself.
Multi-Document Support
With most output formats, xt can translate multiple input files, each containing
one or more independent documents, to a single output stream. For example, a set
of YAML files with documents separated by ---
markers can translate to a
single stream of newline-delimited JSON objects. With format detection enabled,
xt can even translate input files in different formats to a single output.
Streaming Translation
xt can translate multi-document inputs from unbounded sources like shell pipes with minimal buffering, while still supporting features like automatic format detection. Streaming is enabled automatically whenever it's required.
License
xt is released under the terms of the MIT License. See LICENSE.txt
for more
information.
Dependencies
~3.5MB
~70K SLoC