Command line XML beautifier and content extractor. Similar to jq.
A simple way to install the utility is to use the curl and bash installer.
For macOS:
curl -sSL https://git.io/JXZHK | bash
For Linux:
curl -sSL https://git.io/JXZHK | sudo bash
If you have Go toolchain installed, you can use the following command to install xq:
go install github.com/sibprogrammer/[email protected]
Small thing I noticed, for HTML multiline comments the first line gets indented, the other lines stay. Maybe multiline comments should be ignored
raw
<body>
<!--
<p>hello</p>
-->
<p>world</p>
</body>
formatted
<body>
<!--
<p>hello</p>
-->
<p>world</p>
</body>
With file.html with content:
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
</head>
<body>
<p><b>blah</b> (blah)</p>
</body>
</html>
$ xq -m file.html | grep blah
<b>blah</b>(blah)</p>
Note the space is removed between the closing b tag and the opening bracket. This changes the meaning of the content.
Input:
<?xml version="1.0" encoding="UTF-8"?>
<iris1:request xmlns:iris1="urn:ietf:params:xml:ns:iris1">
<iris1:searchSet>
<iris1:lookupEntity registryType="dchk1" entityClass="domain-name" entityName="ficora.fi"/>
</iris1:searchSet>
</iris1:request>
Output:
<?xml version="1.0" encoding="UTF-8"?>
<request iris1="urn:ietf:params:xml:ns:iris1">
<searchSet>
<lookupEntity registryType="dchk1" entityClass="domain-name" entityName="ficora.fi">
</lookupEntity>
</searchSet>
</request>
Sample xml:
<?xml version="1.0" encoding="windows-1251"?>
<xml></xml>
./xq test.xml produces error Error: xml: encoding "windows-1251" declared but Decoder.CharsetReader is nil
The XPath query language is less popular and more verbose compared to CSS selectors.
It is possible to query content using a CSS selector.
The corresponding thread: https://news.ycombinator.com/item?id=33573240
Right now one needs to specify -m flag if HTML input is provided instead of XML. It seems it's possible to implement heuristic algorithm to autodetect the input type.
Autodetection of content type is implemented. No need to provide -m flag in most cases.
It's quite helpful to highlight HTML content, but usually this content is not a valid XML.
An ability to highlight HTML is introduced.
Under certain circumstances, the only formatted output is needed without syntax highlighting. E.g. the terminal does not support colors.
An option to disable the colorful output is introduced.
xq --no-color ./test/data/formatted.xml
The way to extract only a single node using XPath is not so obvious and requires additional typing. Usually, I needed in the first node of the set.
A shortcut to extract only the first node. Here is an example:
cat file.xml | xq -e //item/title
The output will contain the first match of the XPath expression.
Workaround 1:
cat file.xml | xq -x "(//item/title)[1]"
Workaround 2:
cat file.xml | xq -x "//item/title" | head -1
If "less" is defined as $PAGER the control character escape sequences are rendered instead of colors on Linux. Due to unclear reasons, there is no such problem with macOS.
# export PAGER=less ; curl -s https://www.w3schools.com/xml/note.xml | xq
ESC[33m<?ESC[0mxml version="1.0" encoding="UTF-8"ESC[33m?>ESC[0m
ESC[33m<noteESC[0mESC[33m>ESC[0m
ESC[33m<toESC[0mESC[33m>ESC[0mToveESC[33m</to>ESC[0m
ESC[33m<fromESC[0mESC[33m>ESC[0mJaniESC[33m</from>ESC[0m
ESC[33m<headingESC[0mESC[33m>ESC[0mReminderESC[33m</heading>ESC[0m
ESC[33m<bodyESC[0mESC[33m>ESC[0mDon't forget me this weekend!ESC[33m</body>ESC[0m
ESC[33m</note>ESC[0m
The colorful output is expected.
The attribute values in processing instructions are not highlighted.
The example of PI
<?xml version="1.0" encoding="UTF-8"?>
It is expected that values like "1.0" and "UTF-8" are highlighted (similar to other attributes processing).
The utility fails on the attempt to render XML version 1.1.
xq xml-file.xml
Where xml-file.xml contains the following content:
<?xml version='1.1' encoding='UTF-8'?>
<Tag plugin="[email protected]">
<node class="cps.n.StepStartNode" plugin="[email protected]">
<parentIds>
<string>17</string>
</parentIds>
<id>18</id>
<descriptorId>org.jenkinsci.plugins.pipeline.modeldefinition.steps.ScriptStep</descriptorId>
</node>
<actions>
<s.a.LogStorageAction/>
<wf.a.TimingAction plugin="[email protected]">
<startTime>1643040131437</startTime>
</wf.a.TimingAction>
</actions>
</Tag>
Error message saying:
xml: unsupported version "1.1"; only version 1.0 is supported
The file is rendered properly.
One of the sources of such files is Jenkins.
For Linux system that supports snap it is more safe and convenient to use it instead of "curl + bash" combination.
Snap package for xq is prepared.
5b8617f Fix #10: Add an ability to disable syntax highlighting (and enforce it) c0409fd Fix #9: A shortcut to extract a single node 9ae9507 Fix #8: Colorful output with "less" on Linux d6a1436 Fix #7: highlight the attr values in the processing instructions
Source code(tar.gz)b67d070 Fix #4: Add an ability to redefine the indentation way via .xq rcfile a7b39be Fix #6: Use pipes to avoid io buffering 565abea Fix #5: Ability to customize the indentation format via command options fa50ef3 Fix #3: Proper handling of default namespace redeclaration
Source code(tar.gz)373e916 Fix #1: Support non-UTF encodings 8db6095 Fix #2: Proper support for namespaces 9ea51a8 Add information about the license
Source code(tar.gz)1c3e6f1 Show error in the case of malformed XML 9470e71 Use more user-friendly URLs for installer
Source code(tar.gz)twinx is a live-streaming command line tool for Linux. It connects streaming services (like Twitch, OBS and YouTube) together via a common title and description.
A command line tool that extracts attachments and content directly from emL file format messages
Pull Request Me Pull Request Me (PRMe) creates a pull request for the entire content of a Github repository. This is useful to solicit review comments
# Fresh Fresh is a command line tool that builds and (re)starts your web application everytime you save a Go or template file. If the web framework yo
GLab is an open source GitLab CLI tool bringing GitLab to your terminal next to where you are already working with git and your code without switching
readval is a command line tool which is designed for one specific purpose—to prompt for a value to be included in another command line. readval prints
Watcher - Develop your programs easily Watcher watches all the files present in the directory it is run from of the directory that is specified while
asciigraph Go package to make lightweight ASCII line graphs ╭┈╯. Installation go get github.com/guptarohit/asciigraph Usage Basic graph package main
Table of contents Introduction Reference Contributing Introduction Overview git-xargs is a command-line tool (CLI) for making updates across multiple
git-xargs is a command-line tool (CLI) for making updates across multiple GitHub repositories with a single command. You give git-xargs:
Package command Package command provide simple API to create modern command-line interface, mainly for lightweight usage, inspired by cobra Usage pack
dockervol A command line tool for simplified docker volume command built with go. Features: Remove anonymous volume (beta) Remove volume by matching n
Trzsz-go - A simple file transfer tools, similar to lrzsz ( rz / sz ), and compatible with tmux
PretGO So basic cli for format json,html and xml! Table of contents Screenshots Setup Status Contact Screenshots Setup First clone project git clone h
gh markdown-preview GitHub CLI extension to preview your markdown similar to the style of GitHub gh markdown-preview is a GitHub CLI extension to prev
Rclone ("rsync for cloud storage") is a command line program to sync files and directories to and from different cloud storage providers.
csv-sql supports loading and saving results as CSV and XLSX files with data processing with SQLite compatible sql commands including joins.
Website | Documentation | Download | Contributing | Changelog | Installation | Forum Rclone Rclone ("rsync for cloud storage") is a command-line progr
F2 is a cross-platform command-line tool for batch renaming files and directories quickly and safely.
26 Oct 17, 2022
15 Sep 6, 2022
3 Nov 2, 2021
0 Nov 22, 2021
2.1k Dec 30, 2022
0 Dec 22, 2021
1 Mar 27, 2022
2.1k Jan 8, 2023
713 Dec 31, 2022
1 Feb 5, 2022
0 Jan 16, 2022
0 Dec 18, 2021
362 Dec 31, 2022
32 Sep 2, 2022
233 Jan 8, 2023
36.4k Jan 5, 2023
24 Nov 2, 2022
0 Nov 5, 2021
588 Dec 31, 2022