NAME
cek-bpom - Search BPOM products via https://cekbpom.pom.go.id/
VERSION
This document describes version 0.011 of cek-bpom (from Perl distribution App-CekBpom), released on 2020-10-23.
SYNOPSIS
Usage:
% cek-bpom [-P] [--bentuk-sediaan] [--debug] [--format=name] [--json]
[--jumlah-dan-kemasan] [--komposisi] [--log-level=level] [-m] [--merk]
[--(no)naked-res] [--nama-pendaftar] [--nama-produk]
[--nomor-registrasi] [--note=s] [--npwp-pendaftar] [-p]
[--page-result[=program]] [--queries-json=s] [--query-log-file=s]
[--query=s+] [--quiet] [--result-dump-dir=s] [--search-type=s+]
[--search-types-json=s] [-t=s+] [--trace] [--verbose]
[--view-result[=program]] <query> ...
Examples:
By default search against name (nama_produk) and brand (merk):
% cek-bpom hichew hi-chew 'hi chew'
Adding --trace will show query details, --format html+datatables is convenient to see/search/sort results in browser:
% cek-bpom hichew hi-chew 'hi chew' --trace --format html+datatables
DESCRIPTION
Uses LWP::UserAgent::Plugin so you can add retry, caching, or additional HTTP client behavior by setting LWP_USERAGENT_PLUGINS
environment variable.
OPTIONS
*
marks required options.
Main options
- --bentuk-sediaan
-
Shortcut for --search-type=bentuk_sediaan.
See
--search-type
. - --jumlah-dan-kemasan
-
Shortcut for --search-type=jumlah_dan_kemasan.
See
--search-type
. - --komposisi
-
Shortcut for --search-type=komposisi.
See
--search-type
. - --merk
-
Shortcut for --search-type=merk.
See
--search-type
. - --nama-pendaftar
-
Shortcut for --search-type=nama_pendaftar.
See
--search-type
. - --nama-produk
-
Shortcut for --search-type=nama_produk.
See
--search-type
. - --nomor-registrasi
-
Shortcut for --search-type=nomor_registrasi.
See
--search-type
. - --npwp-pendaftar
-
Shortcut for --search-type=npwp_pendaftar.
See
--search-type
. - --queries-json=s
-
See
--query
. - --query=s@*
-
Can be specified multiple times.
- --search-type=s@, -t
-
Select what field(s) to search against.
By default, if not specified, will search against product name ("nama_produk") and brand ("merk"). If you specify multiple times, it will search against all those types, e.g.:
--search-type nama_produk --search-type nama_pendaftar
or:
--nama-produk --nama-pendaftar
Can be specified multiple times.
- --search-types-json=s
-
Select what field(s) to search against (JSON-encoded).
See
--search-type
. - -m
-
Shortcut for --search-type=merk.
See
--search-type
. - -p
-
Shortcut for --search-type=nama_produk.
See
--search-type
. - -P
-
Shortcut for --search-type=nama_pendaftar.
See
--search-type
.
Logging options
- --debug
-
Shortcut for --log-level=debug.
- --log-level=s
-
Set log level.
- --note=s
-
Add note.
This will not be sent as queries, but will be added to the log file if log file is specified, as well as added to the result dump file name, in encoded form.
- --query-log-file=s
-
Log queries to log file.
If specified, each invocation of this utility will be logged into a line in the specified file path, in TSV format. Tab character in the query will be converted into 4 spaces, to avoid clash with the use of Tab as field separator.
For example, this invocation:
% cek-bpom "minuman susu fermentasi" yakult --query-log-file /some/path.txt
Sample log line:
time:2020-10-22T01:02:03.000Z queries:minuman susu fermentasi,yakult search_types:merk,nama_produk num_results:51 duration:3.402
- --quiet
-
Shortcut for --log-level=error.
- --result-dump-dir=s
-
Dump result to directory.
If specified, will dump full enveloped result to a file in specified directory path, in JSON format. The JSON formatting makes it easy to grep each row. The file will be named `cek-bpom-result.<encoded-timestamp>.<search-types-encoded>.<queries-encoded>(.<note-encoded>)?.json`. The encoded timestamp is ISO 8601 format with colon replaced by underscore. The encoded query will replace all every group of "unsafe" characters in query with a single dash. The same goes with encoded note, which comes from the `note` argument. For example, this invocation:
% cek-bpom "minuman susu fermentasi" yakult --note "some note"
will result in a result dump file name like: `cek-bpom-result.2020-10-22T01_02_03.000Z.merk-nama_produk.minuman-susu-fermentasi-yakult.some-note.json`.
- --trace
-
Shortcut for --log-level=trace.
- --verbose
-
Shortcut for --log-level=info.
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]
- --page-result
-
Filter output through a pager.
- --view-result
-
View output using a viewer.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C cek-bpom cek-bpom
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 cek-bpom 'p/*/`cek-bpom`/'
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-CekBpom.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-CekBpom.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CekBpom
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) 2020 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.