/ 
App-INIUtils-0.033
River stage one • 2 direct dependents • 2 total dependents
/ insert-ini-key

NAME

insert-ini-key - Insert a key to INI configuration file

VERSION

This document describes version 0.033 of insert-ini-key (from Perl distribution App-INIUtils), released on 2019-04-23.

SYNOPSIS

Basic usage:

% insert-ini-key /path/to/file.ini section key value

OPTIONS

* marks required options.

Main options

--add

When key already exists, add.

--create-section

When section does not exist, create it first.

--ignore

When key already exists, do nothing.

--inplace

Modify file in-place.

Note that this can only be done if you specify an actual file and not STDIN. Otherwise, an error will be thrown.

--key=s*
--linum=s

Put key line at a specific line number (line number starts from 1).

--replace

When key already exists, delete previous key(s) first.

--section=s*
--top

Add to the beginning of section instead of end.

--value=s*

(Raw) value.

Output options

--format=s

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

Default value:

undef
--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]

Parser options

--default-section=s

Default value:

"GLOBAL"
--disallow-duplicate-key

Other options

--help, -h, -?

Display help message and exit.

--ini=s*

INI file.

--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 insert-ini-key insert-ini-key

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 insert-ini-key 'p/*/`insert-ini-key`/'

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

SOURCE

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

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019, 2015 by 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.