Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sibprogrammer/xq
Command-line XML and HTML beautifier and content extractor
https://github.com/sibprogrammer/xq
cli formatter golang html syntax-highlighting terminal xml xpath
Last synced: 2 months ago
JSON representation
Command-line XML and HTML beautifier and content extractor
- Host: GitHub
- URL: https://github.com/sibprogrammer/xq
- Owner: sibprogrammer
- License: mit
- Created: 2021-11-06T12:59:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T08:39:23.000Z (3 months ago)
- Last Synced: 2024-07-08T10:55:31.114Z (3 months ago)
- Topics: cli, formatter, golang, html, syntax-highlighting, terminal, xml, xpath
- Language: Go
- Homepage:
- Size: 412 KB
- Stars: 787
- Watchers: 10
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps - xq - XML and HTML beautifier and content extractor. (Data Manipulation / Processors)
- fucking-awesome-cli-apps - xq - XML and HTML beautifier and content extractor. (Data Manipulation / Processors)
README
# xq
[](https://github.com/sibprogrammer/xq/actions)
[](https://goreportcard.com/report/github.com/sibprogrammer/xq)
[](https://codecov.io/gh/sibprogrammer/xq)
[](https://github.com/sibprogrammer/xq/)
[](https://formulae.brew.sh/formula/xq)
[](https://repology.org/project/xq-sibprogrammer/versions)
Command-line XML and HTML beautifier and content extractor.
# Features
* Syntax highlighting
* Automatic indentation and formatting
* Automatic pagination
* Node content extraction
# Usage
Format an XML file and highlight the syntax:
```
xq test/data/xml/unformatted.xml
```
`xq` also accepts input through `stdin`:
```
curl -s https://www.w3schools.com/xml/note.xml | xq
```
HTML content can be formatted and highlighted as well (using `-m` flag):
```
xq -m test/data/html/formatted.html
```
It is possible to extract the content using XPath query language.
`-x` parameter accepts XPath expression.
Extract the text content of all nodes with `city` name:
```
cat test/data/xml/unformatted.xml | xq -x //city
```
Extract the value of attribute named `status` and belonging to `user`:
```
cat test/data/xml/unformatted.xml | xq -x /user/@status
```
See https://en.wikipedia.org/wiki/XPath for details.
It is possible to use CSS selector to extract the content as well:
```
cat test/data/html/unformatted.html | xq -q "body > p"
```
Extract an attribute value instead of node content additional option `--attr` (`-a`) can be used:
```
cat test/data/html/unformatted.html | xq -q "head > script" -a "src"
```
Extract part of HTML with tags (not only text content) using CSS selector:
```
cat test/data/html/unformatted.html | xq -n -q "head"
```
# Installation
The preferable ways to install the utility are described below.
For macOS, via [Homebrew](https://brew.sh):
```
brew install xq
```
For macOS, via [MacPorts](https://www.macports.org):
```
sudo port install xq
```
For Linux using custom installer:
```
curl -sSL https://bit.ly/install-xq | sudo bash
```
For Ubuntu 22.10 or higher via package manager:
```
apt-get install xq
```
For Fedora via package manager:
```
dnf install xq
```
A more detailed list of Linux distros that package the `xq` utility can be found here:
https://repology.org/project/xq-sibprogrammer/versions
If you have Go toolchain installed, you can use the following command to install `xq`:
```
go install github.com/sibprogrammer/xq@latest
```
You can play with the `xq` utility using the Dockerized environment:
```
docker-compose run --rm xq
xq /opt/examples/xml/unformatted.xml
```