olx-cli

A command line tool for modifying attributes and content of Open Learning XML (OLX)

• olx-cli
• Usage
• Commands

Usage

$ npm install -g @ibm-skills-network/olx-cli
$ olx-cli COMMAND
running command...
$ olx-cli (-v|--version|version)
@ibm-skills-network/olx-cli/0.1.19 darwin-arm64 node-v20.20.2
$ olx-cli --help [COMMAND]
USAGE
  $ olx-cli COMMAND
...

Commands

• olx-cli help [COMMAND]
• olx-cli list-labs COURSEARCHIVEPATH
• olx-cli set-course COURSEARCHIVEPATH

olx-cli help [COMMAND]

display help for olx-cli

USAGE
  $ olx-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

olx-cli list-labs COURSEARCHIVEPATH

Returns a list of all labs used in the course along with their tool types

USAGE
  $ olx-cli list-labs COURSEARCHIVEPATH

ARGUMENTS
  COURSEARCHIVEPATH  Path to OXL course archive

EXAMPLE
  $ oxl-cli list-labs archive.gz

See code: src/commands/list-labs.ts

olx-cli set-course COURSEARCHIVEPATH

Set course attributes

USAGE
  $ olx-cli set-course COURSEARCHIVEPATH

ARGUMENTS
  COURSEARCHIVEPATH  Path to OXL course archive

OPTIONS
  --addSignatory=addSignatory          Add a certificate signatory (format:
                                       name="X",title="Y",organization="Z",signature="/path/to/file.png")

  --[no-]certificate                   enable certificate

  --courseCard=courseCard              path or url to course card image file. PNG, JPG.

  --graderMinCount=graderMinCount      set min_count on a GRADER entry (format: value=<non-negative
                                       integer>,grader=<0-based index>). grader defaults to 0. Repeatable to target
                                       multiple graders, e.g. --graderMinCount="value=3,grader=0"

  --lti                                enable lti_consumer module

  --ltiPassport=ltiPassport            lti consumer key and secret pair, no speical character is allowed. e.g,
                                       consumer_key:consumer_secret

  --minPassingGrade=minPassingGrade    minimum passing grade as an integer

  --name=name                          course name

  --out=out                            path to output archive

  --overview=overview                  course overview

  --policyXml=policyXml                valid xml string to override course/<url_name>.xml

  --shortDescription=shortDescription  course short description

  --startDate=startDate                course start date

DESCRIPTION
  Update course attributes of an existing course archive.

EXAMPLES
  $ oxl-cli set-course archive.gz --name "New Course Name"
  $ olx-cli set-course archive.gz --graderMinCount="value=1,grader=0"

See code: src/commands/set-course.ts