Commands

ralph

The cli is a stream-based tool to play with your logs.

It offers functionalities to: - Validate or convert learning data in different standards - Read and write learning data to various databases or servers - Manage an instance of a Ralph LRS server

Usage:

ralph [OPTIONS] COMMAND [ARGS]...

Options:

  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO (default) or
                       DEBUG
  --version            Show the version and exit.
  --help               Show this message and exit.

ralph auth

Generate credentials for LRS HTTP basic authentication.

Usage:

ralph auth [OPTIONS]

Options:

  -u, --username TEXT             The user for which we generate credentials.
                                  [required]
  -p, --password TEXT             The password to encrypt for this user. Will
                                  be prompted if missing.  [required]
  -s, --scope TEXT                The user scope(s). This option can be
                                  provided multiple times.  [required]
  -t, --target TEXT               The target location where statements are
                                  stored for the user.
  -M, --agent-ifi-mbox TEXT       The mbox Inverse Functional Identifier of
                                  the associated agent.
  -S, --agent-ifi-mbox-sha1sum TEXT
                                  The mbox-sha1sum Inverse Functional
                                  Identifier of the associated agent.
  -O, --agent-ifi-openid TEXT     The openid Inverse Functional Identifier of
                                  the associated agent.
  -A, --agent-ifi-account TEXT...
                                  Input "{name} {homePage}". The account
                                  Inverse Functional Identifier of the
                                  associated agent.
  -N, --agent-name TEXT           The name of the associated agent.
  -w, --write-to-disk             Write new credentials to the LRS
                                  authentication file.
  --help                          Show this message and exit.

ralph convert

Convert input events to a given format.

Usage:

ralph convert [OPTIONS]

Options:

  From edX to xAPI converter options: 
    -u, --uuid-namespace TEXT     The UUID namespace to use for the `ID` field
                                  generation
    -p, --platform-url TEXT       The `actor.account.homePage` to use in the
                                  xAPI statements  [required]
  -f, --from [edx]                Input events format to convert  [required]
  -t, --to [xapi]                 Output events format  [required]
  -I, --ignore-errors             Continue writing regardless of raised errors
  -F, --fail-on-unknown           Stop converting at first unknown event
  --help                          Show this message and exit.

ralph extract

Extract input events from a container format using a dedicated parser.

Usage:

ralph extract [OPTIONS]

Options:

  -p, --parser [gelf|es]  Container format parser used to extract events
                          [required]
  --help                  Show this message and exit.

ralph validate

Validate input events of given format.

Usage:

ralph validate [OPTIONS]

Options:

  -f, --format [edx|xapi]  Input events format to validate  [required]
  -I, --ignore-errors      Continue validating regardless of raised errors
  -F, --fail-on-unknown    Stop validating at first unknown event
  --help                   Show this message and exit.