swcat - Software catalog
This document describes version 0.015 of swcat (from Perl distribution App-swcat), released on 2021-04-04.
# list software known by local installation (known = has correponding # Software::Catalog::SW::* module installed) % swcat list-installed % swcat list-installed -l ;# detail # list software known by App::swcat (list all available # Software::Catalog::SW::* modules on CPAN) % swcat list-cpan # what is the latest version number of a software? % swcat latest-version firefox ;# by default will be cached for a day % swcat latest-version firefox --no-cache # what is the latest version number of a few software % swcat latest-version firefox seamonkey # list the latest version numbers of all known software % swcat latest-version # list the latest version numbers of known software matching a regex % swcat latest-version /fire|sea/ # get list of available versions of a software % swcat available-versions bulwark-qt # get release note for the latest version of a software % swcat release-note bulwark-qt # get release note for a version of a software % swcat release-note bulwark-qt 1.3.0 # get download URL(s) of a software % swcat download-url firefox % swcat download-url firefox --arch win32
To actually download, install, upgrade software, use instopt (from App::instopt).
Get info of a software archive.
Get list of available architectures of a software.
Get list of available versions of a software.
Get download URL(s) of a software.
Will return the version number in the payload if given a single software name. Will return an array of {software=>..., version=>...} in the payload if given multiple software names or one or more patterns.
Get latest version of one or more software.
List available known software in the catalog (from Software::Catalog::SW::* modules on CPAN).
List known software in the catalog (from installed Software::Catalog::SW::* modules).
Get release note of (a version of) a software.
* marks required options.
*
Set path to configuration file.
Set configuration profile to use.
Location of SQLite database (for caching), defaults to ~/.cache/swcat.db.
Shortcut for --log-level=debug.
Choose output format, e.g. json, text.
Default value:
undef
Display help message and exit.
Set output format to json.
Set log level.
When outputing as JSON, strip result envelope.
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]
Alias for --cache-period=-1.
See --cache-period.
--cache-period
Do not use any configuration file.
Do not read environment for default options.
Filter output through a pager.
Shortcut for --log-level=error.
Update program to latest version from CPAN.
List available subcommands.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Display program's version and exit.
View output using a viewer.
Can be specified multiple times.
See --software-or-pattern.
--software-or-pattern
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C swcat swcat
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.
To activate tcsh completion for this script, put:
complete swcat 'p/*/`swcat`/'
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).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/swcat.conf, ~/swcat.conf, or /etc/swcat.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].
[subcommand=NAME]
[SOMESECTION subcommand=NAME]
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
[subcommand=SUBCOMMAND_NAME profile=SOMENAME]
[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[plugin=DumpArgs] -event=before_validate_args -prio=99 [plugin=Foo] -event=after_validate_args arg1=val1 arg2=val2
which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
cache_period (see --cache-period) db_path (see --db-path) format (see --format) log_level (see --log-level) naked_res (see --naked-res)
arch (see --arch) software (see --software)
software (see --software)
arch (see --arch) softwares_or_patterns (see --software-or-pattern)
softwares_or_patterns (see --software-or-pattern)
detail (see --detail) lcpan (see --lcpan)
detail (see --detail)
arch (see --arch) software (see --software) version (see --version-arg)
Specify additional command-line options.
~/.config/swcat.conf
~/swcat.conf
/etc/swcat.conf
Please visit the project's homepage at https://metacpan.org/release/App-swcat.
Source repository is at https://github.com/perlancar/perl-App-swcat.
Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-swcat/issues
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.
Software::Catalog
App::SoftwareCatalogUtils
instopt from App::instopt
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2019, 2018 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.
To install App::swcat, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::swcat
CPAN shell
perl -MCPAN -e shell install App::swcat
For more information on module installation, please visit the detailed CPAN module installation guide.