CLI reference#
The command-line interface below is generated on every docs build directly from
the live olink.cli.app Typer application (via typer ... utils docs), so the documented commands, options, and defaults are always exactly what
the code exposes — they cannot drift from --help. The enabled component
subcommands (web/gui/interactive/mcp/worker) appear automatically, and only
when present.
olink#
Open external URLs related to your project.
Usage:
$ olink [OPTIONS] COMMAND [ARGS]...
Options:
-V, --version: Show olink version and exit.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
open: Open a target’s URL in the browser.url: Print a target’s URL without opening it.list: List targets available for the current…interactive: Launch the interactive TUI (requires the…version: Show the olink version.info: Show version, Python and platform details…
olink open#
Open a target’s URL in the browser.
Usage:
$ olink open [OPTIONS] {target}
Arguments:
target: Target name (e.g. origin, issues, pypi, snyk:npm). Seeolink list. [required]
Options:
-d, --directory <str>: Project directory (defaults to current directory).--json: Print a single JSON document on stdout instead of text.--help: Show this message and exit.
olink url#
Print a target’s URL without opening it.
Usage:
$ olink url [OPTIONS] {target}
Arguments:
target: Target name (e.g. origin, issues, pypi, snyk:npm). Seeolink list. [required]
Options:
-d, --directory <str>: Project directory (defaults to current directory).--json: Print a single JSON document on stdout instead of text.--help: Show this message and exit.
olink list#
List targets available for the current project.
Usage:
$ olink list [OPTIONS]
Options:
-a, --all: List every target, not only those for this project.-d, --directory <str>: Project directory (defaults to current directory).--json: Print a single JSON document on stdout instead of text.--help: Show this message and exit.
olink interactive#
Launch the interactive TUI (requires the tui extra).
Usage:
$ olink interactive [OPTIONS]
Options:
-d, --directory <str>: Project directory (defaults to current directory).--help: Show this message and exit.
olink version#
Show the olink version.
Usage:
$ olink version [OPTIONS]
Options:
-d, --directory <str>: Project directory (defaults to current directory).--json: Print a single JSON document on stdout instead of text.--help: Show this message and exit.
olink info#
Show version, Python and platform details (useful in bug reports).
Usage:
$ olink info [OPTIONS]
Options:
-d, --directory <str>: Project directory (defaults to current directory).--json: Print a single JSON document on stdout instead of text.--help: Show this message and exit.