/ 
App-fiatx-0.008
River stage one • 1 direct dependent • 1 total dependent
/ fiatx

NAME

fiatx - Currency exchange rate tool

VERSION

This document describes version 0.008 of fiatx (from Perl distribution App-fiatx), released on 2021-05-26.

SYNOPSIS

First, create a MySQL database e.g. fiatx. Then in ~/.config/fiatx.conf:

db_name=fiatx
; the app can also look for passwords in my.cnf
; db_username=...
; db_password=...

; optional. this way, you can just specify USD instead of USD/IDR
;default_quote_currency=IDR

Then:

# Check USD/IDR rates from any source
% fiatx USD/IDR
% fiatx usd      ;# works, if you have set default_quote_currency to IDR

# Check rate from specific source(s) only
% fiatx usd -s bca
% fiatx usd -s bca -s bi

# Check rate and prefer specific types only (in this case: bank notes)
% fiatx usd -t bn

# Check rates of all known pairs from all sources (possible huge list and takes
# a long time, turn on --trace to see progress):
% fiatx --all-pairs --trace

# See available sources
% fiatx -l

DESCRIPTION

OPTIONS

* marks required options.

Main options

--action=s

Default value:

"get_spot_rates"
--default-quote-currency=s
--max-age-cache=s

Above this age (in seconds), we retrieve rate from remote source again.

Default value:

14400
--no-cache

Alias for --max-age-cache 0.

See --max-age-cache.

--query=s
--source=s@, -s

Can be specified multiple times.

--sources-json=s

See --source.

-l

Shortcut for --action=list_sources.

See --action.

Configuration options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Database connection options

--db-name=s
--db-password=s
--db-username=s

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

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

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

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 fiatx 'p/*/`fiatx`/'

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.

CONFIGURATION FILE

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/fiatx.conf, ~/fiatx.conf, or /etc/fiatx.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --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.

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.

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:

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

List of available configuration parameters:

action (see --action)
db_name (see --db-name)
db_password (see --db-password)
db_username (see --db-username)
default_quote_currency (see --default-quote-currency)
format (see --format)
log_level (see --log-level)
max_age_cache (see --max-age-cache)
naked_res (see --naked-res)
query (see --query)
sources (see --source)

ENVIRONMENT

FIATX_OPT => str

Specify additional command-line options.

FILES

~/.config/fiatx.conf

~/fiatx.conf

/etc/fiatx.conf

HOMEPAGE

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

SOURCE

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-fiatx/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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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