XQ(1)

✨ XQ(1) — like, the manual page for xq bestie ✨

okay so. <rainbow>xq</rainbow> is a command-line XML and HTML beautifier and content extractor. that's the whole vibe. it takes your crusty unformatted markup and makes it ✨pretty✨, and it can also reach in and pull out exactly the node or attribute you want. main character tool tbh 💅

---

🌸 SYNOPSIS 🌸

xq [options...] [file]

---

💖 DESCRIPTION 💖

It formats the file you hand it and outputs it in colorful mode. the file can come in as an argument, or you can pipe it through stdin. either way, she's serving. 🎀

---

✨ OPTIONS ✨

so here's the full menu, no skips, no cuts, all of it:

• --version | -v — prints version information and then dips out. 👋
• --help | -h — prints the synopsis plus the whole list of options and exits. your little cheat sheet fr.
• --indent int — uses the number of spaces you give it for indentation. default is 2. 🪄
• --color | -c — forces colorful output. no take-backs.
• --no-color — turns colorful output off (formatting only, no color). sad beige mode 🥲
• --tab — uses tabs instead of spaces for indentation. team tabs rise up 🫶
• --xpath | -x string — extracts the node(s) from XML using the XPath query you provide.
• --extract | -e string — extracts a single node from XML using the XPath query you provide. just the one. 👑
• --query | -q string — extracts the node(s) using a CSS selector.
• --attr | -a string — extracts an attribute value instead of node content, for the CSS query you provide.
• --html | -m — uses the HTML formatter instead of the XML one. 🦋
• --json | -j — outputs the result as JSON.
• --node | -n — returns the node content instead of text.
• --in-place | -i — formats the file in place. it edits the actual file, bestie, so be sure that's what you want 💀

---

🌈 EXAMPLES 🌈

format an XML file and highlight the syntax:

$ xq test/data/xml/unformatted.xml

she also accepts input through stdin, because of course:

$ curl -s https://www.w3schools.com/xml/note.xml | xq

HTML content can be formatted and highlighted using the -m flag:

$ xq -m test/data/html/formatted.html

extract the text content of all nodes with city name:

$ cat test/data/xml/unformatted.xml | xq -x //city

extract the XML content of all nodes with city name:

$ cat test/data/xml/unformatted.xml | xq -n -x //city

---

🎀 SEE ALSO 🎀

• https://github.com/sibprogrammer/xq — official website

---

okay that's the whole page, you ate it up, go format something gorgeous 🧚💜

this page is from the xq man page, dated 06 Nov 2022 — and it's listed under XQ(1). periodt. ⭐