Perinc...pletion(3pm)

📦 version 2.000.2, in ubuntu stonking

💖 Perinci::CmdLine::Manual::HowTo::Completion 💖

okay bestie sit DOWN because we're doing the how-to guides for completion, and this is a page from the User Contributed Perl Documentation (the Perinc...pletion(3pm) one, yes the name is squished, that's just how the header renders it, don't worry about it 🫶).

✨ VERSION ✨

This doc describes version 2.000.2 of Perinci::CmdLine::Manual::HowTo::Completion (she lives inside the Perl distribution Perinci-CmdLine, and she was released on 2026-03-30). slay. 👑

🌸 DESCRIPTION 🌸

so in a Perinci::CmdLine-based CLI program, shell tab completion is mostly just the issue of completing function arguments. that's it, that's the whole vibe. 💅

here's a sample Rinci function metadata so you can see what we're working with:

{
  v => 1.1,
  summary => 'A foo utility',
  args => {
    bar => { ... },
    baz => { ... },
  }
}

completing the names of function arguments? easy peasy, lowkey trivial. they're just taken straight from the list of function arguments in the Rinci function metadata:

% myprog --ba<tab>
bar      baz

but completing function argument values? that's where the meat is, bestie. 🍓 that's the main character of this whole page.

completion can come from simple sources like a schema:

bar => { schema => ['str', in => ['one', 'two', 'three']], ... }
% myprog --bar <tab>
one      three        two

or from more complex sources. iykyk. ✨

🎀 Completion from argument schema

TODO

🎀 Completion from configuration

TODO

🎀 Completion from custom completion routine

TODO

not me teasing you with three whole subsections and every single one is just TODO 😭 the lore is still loading, bestie. the headings are real, the content is coming, we just don't know when. 🧚

🏠 HOMEPAGE

pls come visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine. she's cute, she's iconic, she's got lore. 💖

📦 SOURCE

the source repository lives at https://github.com/perlancar/perl-Perinci-CmdLine. go peek, no cap. 🦋

👀 SEE ALSO

  • Log::ger

👑 AUTHOR

perlancar <perlancar@cpan.org> — the girlboss who made all of this. 🫶

💌 CONTRIBUTING

want to help out? obsessed. here's how:

if you want to contribute, you can send patches by email / via RT, or send pull requests on GitHub. whichever vibe you prefer. ✨

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 do want to build the distribution (like, say, 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. 🙈

this software is copyright (c) 2026 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. periodt. 💅

💀 BUGS

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

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. (do it, it's giving helpful 🌈)

that's the whole page bestie!! no notes, ate, left zero crumbs. 💖✨🎀

and a lil sign-off for the footer situation: this render says perl v5.40.1, dated 2026-04-05, filed under Perinc...pletion(3pm). mwah. 🫶💜

📦 where this page comes from