CLI

Install

cargo install r4pm

This builds the CLI from source, so it needs a Rust toolchain (see rust-lang.org/tools/install).

Usage

r4pm <function> --<argument> <value> ... [output path]

Every function in the API reference is a command. Running r4pm without arguments lists them all.

• Arguments that take an event log or OCEL take a file path. The format follows the extension.
• Strings go in single quotes ('order'). Objects and lists are JSON in single quotes.
• The last argument without -- is the output path. A resulting log or OCEL is exported in the format of its extension; any other result is written as JSON. Without an output path the result is printed.

# Discover a DFG and write it as JSON
r4pm discover_dfg --event_log log.xes dfg.json

# Flatten an OCEL on one object type and export the result as XES
r4pm flatten_ocel_on --ocel ocel.xml --object_type 'order' orders.xes

Every function page has a CLI example in its cli tab.

Links