App::column::run - Run several commands and show their output in multiple columns
This document describes version 0.005 of App::column::run (from Perl distribution App-column-run), released on 2021-07-08.
Sample screenshots:
Usage:
column_run(%args) -> [$status_code, $reason, $payload, \%result_meta]
Run several commands and show their output in multiple columns.
This utility is similar to using the Unix utility pr to columnate output, something like (in bash):
% pr -T -m -w $COLUMNS <(command1 args...) <(command2 args...)
except with the following differences:
commands are run in sequence, not in parallel (although parallel execution is a TODO list item);
all output are collected first, then displayed (although streaming output is a TODO list item);
multiplexing STDIN to all commands;
ANSI color and wide character handling;
passing adjusted COLUMNS environment to commands so they can adjust output;
passing common arguments and environment variables to all commands (as well as allowing each command to have its unique arguments or environment variables).
This function is not exported.
Arguments ('*' denotes required arguments):
args_arrays => array[aos]
Arguments to give to each command (an array of arrays of strings).
If --common-args is also set, then the common arguments will be added first, then the per-command arguments.
--common-args
commands* => array[str]
common_args => array[str]
Common arguments to pass to each command.
If --args-arrays is also set, then the common arguments will be added first, then the per-command arguments.
--args-arrays
common_envs => hash
Common environment variables to pass to each command.
envs_arrays => array[hos]
Environment variables to give to each command (an array of hashes of strings).
linum_width => posint
Line number width.
on_long_line => str (default: "clip")
What to do to long lines.
separator => str (default: "|")
Separator character between columns.
show_linum => bool
Show line number.
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/App-column-run.
Source repository is at https://github.com/perlancar/perl-App-column-run.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-column-run
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Terminal multiplexers: tmux, screen.
Terminal emulator with multiple tabs, e.g. Konsole, GNOME Terminal.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2020 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::column::run, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::column::run
CPAN shell
perl -MCPAN -e shell install App::column::run
For more information on module installation, please visit the detailed CPAN module installation guide.