Usage

You can use Pyfx in two ways:

  • A standalone CLI tool

  • A python module which can be integrated in any python CLI application

CLI

pyfx

pyfx command line entry point.

It loads JSON from various sources and opens Pyfx’s UI for browsing.

Examples

  1. load JSON from clipboard

    pyfx -x | –from-clipboard

  2. load JSON from file

    pyfx data.json

  3. load JSON from pipe

    cat data.json | pyfx

pyfx [OPTIONS] [FILE]...

Options

--help

Show this message and exit.

--version

Show the version and exit.

--debug

Enable debug level logging.

-c, --config-file <config_file>

Absolute path of pyfx config file

-x, --from-clipboard

Read JSON from clipboard

Arguments

FILE

Optional argument(s)

Python Module

Directly Attach Pyfx Simple TUI

Directly integrate Pyfx’s TUI into your own project, see example for details.

Integrate with Your Own Urwid-based TUI

Integrate Pyfx native JSON-lib into your own Urwid-based TUI, see example for details.