owi-cli
Command line interface for accessing the Open Web Index shards and slices.
Star
Fork
Watch
owi-cli docs source details admin.md
3.1 kB · 146 lines
Markdown
at main

Admin Commands #

Admin commands (owi admin) support troubleshooting, repository inspection, and low-level filesystem diagnostics.

admin repos #

List configured repositories and their connection status.

Usage #

owi admin repos

admin path #

Check whether a given path exists in one repository or across all configured repositories.

Usage #

owi admin path PATH [OPTIONS]

Options #

  • --repository REPO (-r): Restrict checks to a single repository.

Examples #

owi admin path /IT4ILexisV2/public/<DATASET_ID> --repository lexis
owi admin path /OWILRZZONE/LEXIS/<resource>/public/<DATASET_ID>

admin fs #

Run low-level filesystem operations on repository backends.

Usage #

owi admin fs OPERATION PATH [OPTIONS]

Operations #

  • Read-only: ls, exists, info, find, glob, cat
  • Modifying: mkdir, cp, mv, rm

Options #

  • --repository REPO (-r): Repository name (default: lexis)
  • --target-path PATH (-t): Destination path for cp and mv
  • --pattern GLOB (-p): Optional filter for find/glob
  • --recursive: Recursive behavior for supported ops (rm, some copy/move/list cases)
  • --max-items N: Max printed items for list-like ops (default: 50)
  • --yes (-y): Skip confirmation for modifying operations

Safeguards #

  • Modifying operations (mkdir, cp, mv, rm) require an interactive confirmation unless --yes is used.

Examples #

owi admin fs exists /IT4ILexisV2/public/<DATASET_ID> --repository lexis
owi admin fs ls /OWILRZZONE/LEXIS/<resource>/public/<DATASET_ID> --repository lexis --max-items 20
owi admin fs glob "/OWILRZZONE/LEXIS/<resource>/public/<DATASET_ID>/**/*.parquet" --repository lexis

admin logs #

View application logs.

Usage #

owi admin logs [LOG_SELECTOR] [OPTIONS]

Log selectors #

  • latest: most recently modified .log or .json log file in ~/.owi/.logs
  • location: print the log directory and known log file locations
  • events: show events.json
  • sql: show sql.log
  • lexis, errors: show named log files when present
  • any explicit filename in ~/.owi/.logs

Options #

  • --lines, -n: Number of lines to show (default: 50)
  • --follow, -f: Reserved follow mode flag

Examples #

owi admin logs latest
owi admin logs sql --lines 100
owi admin logs events --lines 20
owi admin logs location

Notes #

  • events is stored as JSON lines in events.json.
  • SQL debugging output is only written when commands are run with the global --sql-log flag.
  • location is the quickest way to confirm where events.json, sql.log, and other logs live in the active OWI target directory.

admin stats #

Display usage statistics.

Usage #

owi admin stats

admin check #

Validate and optionally repair metadata for datasets matching a specifier.

Usage #

owi admin check SPECIFIER [OPTIONS]

Examples #

owi admin check lrz:latest
owi admin check all/collectionName=main --repair=infer --update=update