Manual section: 1
Manual group: user

jnrbase¶

Common utility functionality¶

SYNOPSIS¶

jnrbase [option]… <command>

DESCRIPTION¶

jnrbase provides an unsorted collection of library functionality, and this program provides access to some of that from the shell.

It isn’t really meant to be a heavily used user facing program, but as the functionality is occasionally useful providing direct access can be a fun bonus.

OPTIONS¶

--version¶: Show the version and exit.

--help¶: Show help message and exit.

COMMANDS¶

jnrbase config¶

Extract or list values from config.

jnrbase config [OPTIONS] PACKAGE SECTION [KEY]

Options

-n, --name <name>¶: Config file to read from.

-l, --local, --no-local¶: Read local .<package>rc files.

Arguments

PACKAGE¶: Required argument

SECTION¶: Required argument

KEY¶: Optional argument

jnrbase dirs¶

Query package directories.

jnrbase dirs [OPTIONS] COMMAND [ARGS]...

cache¶

Display cache dir honouring XDG basedir.

jnrbase dirs cache [OPTIONS] PACKAGE

Arguments

PACKAGE¶: Required argument

config¶

Display config dir honouring XDG basedir.

jnrbase dirs config [OPTIONS] PACKAGE

Arguments

PACKAGE¶: Required argument

data¶

Display data dir honouring XDG basedir.

jnrbase dirs data [OPTIONS] PACKAGE

Arguments

PACKAGE¶: Required argument

jnrbase find-tag¶

jnrbase find-tag [OPTIONS]

Options

-m, --match <match>¶: Limit the selection of matches with glob.

-s, --strict, --no-strict¶: Always generate a result.

-d, --directory <directory>¶: Git repository to operate on.

jnrbase gen-text¶

Create output from Jinja template.

jnrbase gen-text [OPTIONS] PACKAGE TMPL

Options

-e, --env <env>¶: JSON data to generate output with.

Arguments

PACKAGE¶: Required argument

TMPL¶: Required argument

jnrbase messages¶

Format messages for users.

jnrbase messages [OPTIONS] COMMAND [ARGS]...

fail¶

Format a failure message.

jnrbase messages fail [OPTIONS] TEXT

Arguments

TEXT¶: Required argument

info¶

Format an informational message.

jnrbase messages info [OPTIONS] TEXT

Arguments

TEXT¶: Required argument

success¶

Format a success message.

jnrbase messages success [OPTIONS] TEXT

Arguments

TEXT¶: Required argument

warn¶

Format a warning message.

jnrbase messages warn [OPTIONS] TEXT

Arguments

TEXT¶: Required argument

jnrbase pip-requires¶

Parse pip requirements file.

jnrbase pip-requires [OPTIONS] NAME

Arguments

NAME¶: Required argument

jnrbase pretty-time¶

Format timestamp for human consumption.

jnrbase pretty-time [OPTIONS] TIMESTAMP

Arguments

TIMESTAMP¶: Required argument

jnrbase time¶

Time the output of a command.

jnrbase time [OPTIONS] COMMAND

Arguments

COMMAND¶: Required argument

BUGS¶

None known.

AUTHOR¶

Written by James Rowe

RESOURCES¶

Full documentation: https://jnrbase.readthedocs.io/

Issue tracker: https://github.com/JNRowe/jnrbase/issues/

COPYING¶

jnrbase is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

jnrbase is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with jnrbase. If not, see <http://www.gnu.org/licenses/>.