Command line interface

The library has a command line interface to interact with the datamesh and storage system for bulk operations and administration tasks.

Top level commands

$ oceanum --help
Usage: oceanum [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  auth      Authentication commands
  datamesh  Datamesh Datasources commands
  prax      Oceanum PRAX Projects Management
  storage   Oceanum Storage commands

Auth commands

$ oceanum auth --help
Usage: oceanum auth [OPTIONS] COMMAND [ARGS]...

  Authentication commands

Options:
  --help  Show this message and exit.

Commands:
  login
  logout

Datamesh commands

$ oceanum datamesh --help
Usage: oceanum datamesh [OPTIONS] COMMAND [ARGS]...

  Datamesh Datasources commands

Options:
  --help  Show this message and exit.

Commands:
  list

Datasources commands

List datasources

$ oceanum datamesh list datasources --help
Usage: oceanum datamesh list datasources [OPTIONS]

Options:
  --search TEXT    Search string
  --limit INTEGER  Limit results
  --help           Show this message and exit.

Storage commands

$ oceanum storage --help
Usage: oceanum storage [OPTIONS] COMMAND [ARGS]...

  Oceanum Storage commands

Options:
  --help  Show this message and exit.

Commands:
  get  Copy content from SOURCE to DEST.
  ls   List contents in the oceanum storage (the root directory by default).
  put  Copy content from SOURCE to DEST.
  rm   Remove PATH.

List content in storage system

$ oceanum storage ls --help
Usage: oceanum storage ls [OPTIONS] [PATH]

  List contents in the oceanum storage (the root directory by default).

Options:
  -l, --long            Long listing format
  -h, --human-readable  Readable sizes with -l
  -r, --recursive       List subdirectories recursively
  --help                Show this message and exit.

Copy content from storage system

$ oceanum storage get --help
Usage: oceanum storage get [OPTIONS] SOURCE DEST

  Copy content from SOURCE to DEST.

Options:
  -r, --recursive  Copy directories recursively
  --help           Show this message and exit.

Upload content to storage system

$ oceanum storage put --help
Usage: oceanum storage put [OPTIONS] SOURCE DEST

  Copy content from SOURCE to DEST.

Options:
  -r, --recursive  Copy directories recursively
  --help           Show this message and exit.

Remove content from storage system (not implemented yet)

$ oceanum storage rm --help
Usage: oceanum storage rm [OPTIONS] PATH

  Remove PATH.

Options:
  -r, --recursive  Remove directories recursively
  --help           Show this message and exit.

Oceanum PRAX commands

Please refer to the Oceanum PRAX documentation for more details.