grcli - Man Page

grout command line interface

Synopsis

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

Options

-h,  --help

Show usage help and exit.​

-s <file>, --socket <file>

Path to the control plane API socket.​

-e,  --err-exit

Abort on first error.​

-j,  --json

Output tables and objects in JSON format.​

-p,  --no-pager

Do not pipe output into a pager.​

-x,  --trace-commands

Print executed commands.​

-f <file>, --file <file>

Read commands from PATH instead of standard input.​

-V,  --version

Print version and exit.​

-c,  --bash-complete

For use in bash completion.​

-d,  --dump-commands

Dump the command tree in JSON format.​

Environment

GROUT_SOCK_PATH

Path to the control plane API socket.​ If not set, defaults to /run/grout.​sock.​

GROUT_PAGER

Pager program used to display command output.​ Takes precedence over PAGER.​ Set to an empty string to disable paging.​ Default: less(1).​

PAGER

Fallback pager program if GROUT_PAGER is not set.​

DPRC

Set the DPRC - 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.​ While grcli can configure grout without this environment setting, autocompletion of the devargs will not be available.​

See Also

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

Report bugs to the grout project issue tracker at <https://github.​com/DPDK/grout/issues>.​

Referenced By

grcli-address(1), grcli-affinity(1), grcli-conntrack(1), grcli-dnat44(1), grcli-events(1), grcli-fdb(1), grcli-flood(1), grcli-graph(1), grcli-interface(1), grcli-log(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), grout-frr(7).

2026-08-21