NAME

parse-keyvalue-filename - Parse filename using the KeyValue naming scheme

VERSION

This document describes version 0.003 of parse-keyvalue-filename (from Perl distribution App-FilenameKeyValueUtils), released on 2026-05-29.

SYNOPSIS

parse-keyvalue-filename --help (or -h, -?)

parse-keyvalue-filename --version (or -v)

parse-keyvalue-filename [--array-value=int] [--decode-value|--no-decode-value|--nodecode-value] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] -- <filename>

See examples in the "EXAMPLES" section.

DESCRIPTION

The KeyValue naming scheme puts key=value pairs at the end of filename. Filename must match this regex:

/\A
 (?:
  (.+?)                                 # optional prefix (part before the first key)
  -
 )?
 (
 (?:
   ([A-Za-z_][A-Za_z0-9_]*)              # key
   =
   ([^-]*)                               # value
 )
 (?:
   -
   ([A-Za-z_][A-Za_z0-9_]*)
   =
   ([^-]*)
 )*
 (\.\w+)?                                # optional filename extension
 \z/x

KeyValue naming scheme is used in the AssetView media assets organization scheme (see Media::AssetView).

This routine parses a filename and return a structure containing parsed elements.

OPTIONS

* marks required options.

Main options

--array-value=s

Always/never/maybe return value as array.

Default value:

Valid values:

[0,1,2]

The default (1) is to return a scalar when there is a single value, or an array if there are multiple values, for example:

foo-kw1=val1-kw2=val2,val2b-kw3=val3-kw1=val1b.jpg

then:

kw1 = ['val1', 'val1b']
kw2 = ['val2', 'val2b']
kw3 = 'val3'

The setting 0 means to never return array, so will return a comma-separated string instead. However, if the value is URI-decoded then this can potentially be ambiguous:

kw1=val1,val2-kw1=val3%2cval4.jpg

under array_value=0 and decode_value=1 will return:

kw1 = 'val1,val2,val3,val4'

while under array_value=1 or 2 will return 3 elements:

kw1 = ['val1', 'val2', 'val3,val4']

--filename=s*

(No description)

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

--no-decode-value

(No description)

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:

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 parse-keyvalue-filename parse-keyvalue-filename

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 parse-keyvalue-filename 'p/*/`parse-keyvalue-filename`/'

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.

EXAMPLES

No key=value pairs

% parse-keyvalue-filename foo.jpg
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {},
      "kv_raw" : "",
      "prefix" : "foo"
   },
   {}
]

A single key=value pair

% parse-keyvalue-filename 'foo-bar-kw1=val1.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1" : [
            "val1"
         ]
      },
      "kv_raw" : "kw1=val1",
      "prefix" : "foo-bar-"
   },
   {}
]

Two key=value pairs

% parse-keyvalue-filename 'foo-bar-kw1=val1-kw2=val2.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1" : [
            "val1"
         ],
         "kw2" : [
            "val2"
         ]
      },
      "kv_raw" : "kw1=val1-kw2=val2",
      "prefix" : "foo-bar-"
   },
   {}
]

A single key=value pair containing two values

% parse-keyvalue-filename 'foo-bar-kw1=val1,val1b.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1" : [
            "val1",
            "val1b"
         ]
      },
      "kv_raw" : "kw1=val1,val1b",
      "prefix" : "foo-bar-"
   },
   {}
]

Three key=value pairs, one containing multiple values

% parse-keyvalue-filename 'foo-bar-kw1=val1-kw2=val2,val2b,val2c-kw3=val3.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1" : [
            "val1"
         ],
         "kw2" : [
            "val2",
            "val2b",
            "val2c"
         ],
         "kw3" : [
            "val3"
         ]
      },
      "kv_raw" : "kw1=val1-kw2=val2,val2b,val2c-kw3=val3",
      "prefix" : "foo-bar-"
   },
   {}
]

Empty key=value pairs

% parse-keyvalue-filename 'foo-bar-kw1=-kw2=-kw3=val.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw3" : [
            "val"
         ]
      },
      "kv_raw" : "kw1=-kw2=-kw3=val",
      "prefix" : "foo-bar-"
   },
   {}
]

A value containing dash

% parse-keyvalue-filename 'foo-bar-kw1_containing_dash=containing%2ddash-kw2_also_containing_dash=containing%2Dtwo%2Ddashes.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1_containing_dash" : [
            "containing-dash"
         ],
         "kw2_also_containing_dash" : [
            "containing-two-dashes"
         ]
      },
      "kv_raw" : "kw1_containing_dash=containing%2ddash-kw2_also_containing_dash=containing%2Dtwo%2Ddashes",
      "prefix" : "foo-bar-"
   },
   {}
]

A value containing comma

% parse-keyvalue-filename 'foo-bar-kw1=containing%2ccomma.jpg'
[
   200,
   "OK",
   {
      "ext" : "jpg",
      "kv" : {
         "kw1" : [
            "containing",
            "comma"
         ]
      },
      "kv_raw" : "kw1=containing%2ccomma",
      "prefix" : "foo-bar-"
   },
   {}
]

HOMEPAGE

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

SOURCE

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

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 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-FilenameKeyValueUtils

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::FilenameKeyValueUtils, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::FilenameKeyValueUtils

CPAN shell

perl -MCPAN -e shell
install App::FilenameKeyValueUtils

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Output options

Other options

COMPLETION

bash

tcsh

other shells

EXAMPLES

No key=value pairs

A single key=value pair

Two key=value pairs

A single key=value pair containing two values

Three key=value pairs, one containing multiple values

Empty key=value pairs

A value containing dash

A value containing comma

HOMEPAGE

SOURCE

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions

Keyboard Shortcuts