GRCLI(1)

💖 GRCLI(1) — the grout command line interface 💖

okay bestie, welcome to grcli, aka the grout command line interface — and yes, it's from the General Commands Manual section, so you know it's the real deal. this is your lil chat window into grout and honestly? iconic.

---

✨ SYNOPSIS ✨

grcli [-h] [-s <file>] [-e] [-j] [-p] [-x] [-f <file>] [-V] [-c] [-d]

look at her. nine flags. main character energy, no cap. 🎀

---

🌸 OPTIONS 🌸

every single flag, coming right up, bestie — nothing skipped, nothing skipped, periodt:

• -h, --help — shows you the usage help and then dips. the "hey what do i even type" button. 💅
• -s <file>, --socket <file> — the path to the control plane API socket. your little phone line to grout.
• -e, --err-exit — abort on the first error. no second chances, she's dramatic like that. 🛑
• -j, --json — outputs tables and objects in JSON format. for when you're feeling machine-readable. 🤖
• -p, --no-pager — do not pipe output into a pager. just let it spill straight onto your terminal.
• -x, --trace-commands — prints the executed commands. narrator voice: she's telling you everything she did.
• -f <file>, --file <file> — read commands from PATH instead of standard input. batch mode era. 📄
• -V, --version — prints the version and exits. the "who even are you" flag.
• -c, --bash-complete — for use in bash completion. not for you, bestie, this one's for your shell. 🐚
• -d, --dump-commands — dumps the command tree in JSON format. the whole family tree, exposed. 🌳

---

🌈 ENVIRONMENT 🌈

the vibes your environment can set for her. she reads these, so treat them with respect:

• GROUT_SOCK_PATH — path to the control plane API socket. if you don't set it, it defaults to /run/grout.sock.
• GROUT_PAGER — the pager program used to display command output. takes precedence over PAGER. set it to an empty string to disable paging entirely. default: less(1).
• PAGER — the fallback pager program if GROUT_PAGER isn't set. the understudy. 🎭
• DPRC — set the DPRC, aka the Datapath Resource Container. this value should match the one used by DPDK during the scan of the fslmc bus. it is recommended to set this on any NXP QorIQ targets. this serves as the entry point for grcli to enable autocompletion of fslmc devices manageable by grout. and like, plot twist: while grcli can configure grout without this environment setting, autocompletion of the devargs will not be available. so set it. do it for her. 🙈

ngl the DPRC one is giving "you can technically live without it but why would you" energy. no autocompletion = sad girl hours. 😭

---

🦋 SEE ALSO 🦋

her whole friend group, go say hi:

• grcli-address(1)
• grcli-affinity(1)
• grcli-conntrack(1)
• grcli-dhcp(1)
• grcli-dnat44(1)
• grcli-events(1)
• grcli-fdb(1)
• grcli-flood(1)
• grcli-graph(1)
• grcli-interface(1)
• grcli-json(1)
• grcli-log(1)
• grcli-mac(1)
• grcli-nexthop(1)
• grcli-ping(1)
• grcli-route(1)
• grcli-router-advert(1)
• grcli-snat44(1)
• grcli-stats(1)
• grcli-trace(1)
• grcli-traceroute(1)
• grcli-tunsrc(1)
• grout(8)

---

💜 REPORTING BUGS 💜

found a bug? don't be shy, don't suffer in silence — report bugs to the grout project issue tracker at <https://github.com/DPDK/grout/issues>. the devs literally want to know. 🫶

---

that's the whole page, bestie. written on 2026-10-01, from the GRCLI(1) manual page, version GRCLI(1) — go forth and configure grout, you absolute legend. 👑 ✨