/ 
App-genusername-0.001
River stage zero No dependents
/ genusername

NAME

genusername - Generate random username

VERSION

This document describes version 0.001 of genusername (from Perl distribution App-genusername), released on 2024-01-16.

SYNOPSIS

genusername --help (or -h, -?)

genusername --version (or -v)

genusername [--action=str|--list-patterns] [--case=str|-L|-U] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [(--pattern=str)+|--patterns-json=json|(-p=str)+] -- [num]

DESCRIPTION

This is a thin wrapper for genpw.

OPTIONS

* marks required options.

Main options

--action=s

Default value:

"gen"

Valid values:

["gen","list-patterns"]
--case=s

Force casing.

Default value:

"default"

Valid values:

["default","random","lower","upper","title"]

default means to not change case. random changes casing some letters randomly to lower-/uppercase. lower forces lower case. upper forces UPPER CASE. title forces Title case.

--list-patterns

Shortcut for --action=list-patterns.

See --action.

--num=s, -n

Default value:

1

Can also be specified as the 1st command-line argument.

--pattern=s@, -p

Pattern(s) to use.

CONVERSION (%P). A pattern is string that is roughly similar to a printf pattern:

%P

where P is certain letter signifying a conversion. This will be replaced with some other string according to the conversion. An example is the %h conversion which will be replaced with hexdigit.

LENGTH (%NP). A non-negative integer (N) can be specified before the conversion to signify desired length, for example, %4w will return a random word of length 4.

MINIMUM AND MAXIMUM LENGTH (%M$NP). If two non-negative integers separated by $ is specified before the conversion, this specify desired minimum and maximum length. For example, %4$10h will be replaced with between 4 and 10 hexdigits.

ARGUMENT AND FILTERS (%(arg)P, %(arg)(filter1)(...)P). Finally, an argument followed by zero or more filters can be specified (before the lengths) and before the conversion. For example, %(wordlist:ID::KBBI)w will be replaced by a random word from the wordlist WordList::ID::KBBI. Another example, %()(Str::uc)4$10h will be replaced by between 4-10 uppercase hexdigits, and %(arraydata:Sample::DeNiro)(Str::underscore_non_latin_alphanums)(Str::lc)(Str::ucfirst)w will be replaced with a random movie title of Robert De Niro, where symbols are replaced with underscore then the string will be converted into lowercase and the first character uppercased, e.g. Dear_america_letters_home_from_vietnam.

Anything else will be left as-is.

Available conversions:

%l   Random Latin letter (A-Z, a-z)
%d   Random digit (0-9)
%h   Random hexdigit (0-9a-f in lowercase [default] or 0-9A-F in uppercase).
     Known arguments:
     - "u" (to use the uppercase instead of the default lowercase digits)
%a   Random letter/digit (Alphanum) (A-Z, a-z, 0-9; combination of %l and %d)
%s   Random ASCII symbol, e.g. "-" (dash), "_" (underscore), etc.
%x   Random letter/digit/ASCII symbol (combination of %a and %s)
%m   Base64 character (A-Z, a-z, 0-9, +, /)
%b   Base58 character (A-Z, a-z, 0-9 minus IOl0)
%B   Base56 character (A-Z, a-z, 0-9 minus IOol01)
%%   A literal percent sign
%w   Random word. Known arguments:
     - "stdin:" (for getting the words from stdin, the default)
     - "wordlist:NAME" (for getting the words from a L<WordList> module)
     - "arraydata:NAME" (for getting the words from an L<ArrayData> module, the
       Role::TinyCommons::Collection::PickItems::RandomPos will be applied).

Filters are modules in the Data::Sah::Filter::perl:: namespace.

Can be specified multiple times.

--patterns-json=s

Pattern(s) to use (JSON-encoded).

See --pattern.

-L

Shortcut for --case=lower.

See --case.

-U

Shortcut for --case=upper.

See --case.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]
--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C genusername genusername

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.

tcsh

To activate tcsh completion for this script, put:

complete genusername 'p/*/`genusername`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-genusername.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-genusername.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-genusername

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.