Complete::Fish::Gen::FromPerinciCmdLine - Dump Perinci::CmdLine script and generate fish completion from it


This document describes version 0.004 of Complete::Fish::Gen::FromPerinciCmdLine (from Perl distribution Complete-Fish-Gen-FromPerinciCmdLine), released on 2016-10-28.



gen_fish_complete_from_perinci_cmdline_script(%args) -> [status, msg, result, meta]

Dump Perinci::CmdLine script and generate fish completion from it.

This routine generate complete fish command for each option, allowing fish to display the options in a different color.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • cmdname => str

    Command name (by default will be extracted from filename).

  • compname => str

    Completer name (in case different from cmdname).

  • filename* => filename

  • skip_detect => bool

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: A script that can be fed to the fish shell (str)


Please visit the project's homepage at


Source repository is at


Please report any bugs or feature requests on the bugtracker website

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.


perlancar <>


This software is copyright (c) 2016 by

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.