list-tagged-dirs - Search tagged directories recursively in a list of places
This document describes version 0.001 of list-tagged-dirs (from Perl distribution App-TaggedDirUtils), released on 2021-08-23.
Usage:
% list-tagged-dirs [--debug|--log-level=level|--quiet|--trace|--verbose] [--detail|-l|--no-detail|--nodetail] [--format=name|--json] [(--has-file=filename)+] [(--has-tag=str)+] [(--lacks-file=filename)+] [(--lacks-tag=str)+] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--has-files-json=json] [--has-tags-json=json] [--lacks-files-json=json] [--lacks-tags-json=json] -- <prefixes> ...
Note: when a tagged dir is found, its contents are no longer recursed to search for other tagged dirs.
* marks required options.
*
Can be specified multiple times.
See --has-file.
--has-file
See --has-tag.
--has-tag
See --lacks-file.
--lacks-file
See --lacks-tag.
--lacks-tag
Changes file (JSON-encoded).
See --prefixes.
--prefixes
Can also be specified as the 1st command-line argument and onwards.
Changes file.
Location(s) to search for tagged subdirectories, i.e. directories which have some file with specific names in its root.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C list-tagged-dirs list-tagged-dirs
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete list-tagged-dirs 'p/*/`list-tagged-dirs`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
How many datadirs are here?:
% list-tagged-dirs --has-tag datadir --lacks-file .git . | wc -l
List all media tagged directories in all my external drives (show name as well as path):
% list-tagged-dirs --has-tag media --lacks-file .git -l /media/budi /media/ujang
Backup all my mediadirs to Google Drive:
% list-tagged-dirs --has-tag media --lacks-file .git -l /media/budi /media/ujang | td map '"rclone copy -v -v $_->{abs_path} mygdrive:/backup/$_->{name}"' | bash
Please visit the project's homepage at https://metacpan.org/release/App-TaggedDirUtils.
Source repository is at https://github.com/perlancar/perl-App-TaggedDirUtils.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2021 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-TaggedDirUtils
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.
To install App::TaggedDirUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::TaggedDirUtils
CPAN shell
perl -MCPAN -e shell install App::TaggedDirUtils
For more information on module installation, please visit the detailed CPAN module installation guide.