Skip to main content

lkr

A CLI for Looker with helpful tools

Usage:

$ lkr [OPTIONS] COMMAND [ARGS]...

Options:

  • --client-id TEXT: [env var: LOOKERSDK_CLIENT_ID]
  • --client-secret TEXT: [env var: LOOKERSDK_CLIENT_SECRET]
  • --base-url TEXT: [env var: LOOKERSDK_BASE_URL]
  • --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]: [env var: LOG_LEVEL]
  • --quiet
  • --force-oauth
  • --dev
  • --oauth-account TEXT: OAuth account to lookup in DB and use regardless of what's active
  • --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:

  • db-template
  • auth: Authentication commands for LookML Repository
  • mcp
  • observability
  • tools
  • code-mode

lkr db-template

Usage:

$ lkr db-template [OPTIONS]

Options:

  • --import-error TEXT: [default: No module named 'lkr.db_template.main']

lkr auth

Authentication commands for LookML Repository

Usage:

$ lkr auth [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • login: Login to Looker instance using OAuth2 or...
  • logout: Logout and clear saved credentials
  • whoami: Check current authentication
  • list: List all authenticated Looker instances

lkr auth login

Login to Looker instance using OAuth2 or switch to an existing authenticated instance

Usage:

$ lkr auth login [OPTIONS]

Options:

  • -I, --instance-name TEXT: Name of the Looker instance to login or switch to
  • -p, --port INTEGER RANGE: Port to run the local OAuth redirect web server on [1<=x<=65535]
  • --help: Show this message and exit.

lkr auth logout

Logout and clear saved credentials

Usage:

$ lkr auth logout [OPTIONS]

Options:

  • --instance-name TEXT: Name of the Looker instance to logout from. If not provided, logs out from all instances.
  • --all: Logout from all instances
  • --help: Show this message and exit.

lkr auth whoami

Check current authentication

Usage:

$ lkr auth whoami [OPTIONS]

Options:

  • --help: Show this message and exit.

lkr auth list

List all authenticated Looker instances

Usage:

$ lkr auth list [OPTIONS]

Options:

  • --help: Show this message and exit.

lkr mcp

Usage:

$ lkr mcp [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • run

lkr mcp run

Usage:

$ lkr mcp run [OPTIONS]

Options:

  • --debug / --no-debug: Debug mode [default: no-debug]
  • --help: Show this message and exit.

lkr observability

Usage:

$ lkr observability [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • embed: Start the observability FastAPI server.

lkr observability embed

Start the observability FastAPI server.

Usage:

$ lkr observability embed [OPTIONS]

Options:

  • --host TEXT: Host to bind to [env var: HOST; default: 0.0.0.0]
  • --port INTEGER: Port to bind to [env var: PORT; default: 8080]
  • --timeout INTEGER: Timeout for the health check [env var: TIMEOUT; default: 120]
  • --event-prefix TEXT: Event prefix [env var: EVENT_PREFIX; default: lkr-observability]
  • --help: Show this message and exit.

lkr tools

Usage:

$ lkr tools [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • user-attribute-updater
  • schedule-download-deprecation: Build a table of users and their...
  • lookml: LookML synchronization and deployment tools

lkr tools user-attribute-updater

Usage:

$ lkr tools user-attribute-updater [OPTIONS]

Options:

  • --host TEXT: [env var: HOST; default: 127.0.0.1]
  • --port INTEGER: [env var: PORT; default: 8080]
  • --help: Show this message and exit.

lkr tools schedule-download-deprecation

Build a table of users and their scheduling/downloading permissions per model.

Usage:

$ lkr tools schedule-download-deprecation [OPTIONS]

Options:

  • --limit INTEGER: Search batch size [default: 500]
  • --model-offset INTEGER: Offset for model columns [default: 0]
  • --csv: Output as CSV instead of a table
  • --csv-file-name TEXT: Name for the output CSV file (without extension) [default: schedule_download_deprecation]
  • --unfiltered: Show all rows, including those with no missing permissions
  • --email: Use Email instead of Name
  • --help: Show this message and exit.

lkr tools lookml

LookML synchronization and deployment tools

Usage:

$ lkr tools lookml [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • push: Push local files to Looker, removing files...
  • pull: Pull remote files from Looker to local...
  • deploy: Commit dev workspace and deploy Looker...

lkr tools lookml push

Push local files to Looker, removing files on the instance that aren't being pushed.

Usage:

$ lkr tools lookml push [OPTIONS] FOLDER_NAME

Arguments:

  • FOLDER_NAME: Local folder name / Looker project ID to push [required]

Options:

  • --project-id, --project TEXT: Looker project ID to push to (if different from folder name)
  • --deploy: Commit and deploy to production after push
  • --message TEXT: Commit message when deploying [default: push from lkr cli]
  • --help: Show this message and exit.

lkr tools lookml pull

Pull remote files from Looker to local disk, removing local files that aren't on the instance.

Usage:

$ lkr tools lookml pull [OPTIONS] FOLDER_NAME

Arguments:

  • FOLDER_NAME: Local folder name / Looker project ID to pull into [required]

Options:

  • --project-id, --project TEXT: Looker project ID to pull from (if different from folder name)
  • --deploy: Commit and deploy to production on Looker after pull
  • --message TEXT: Commit message when deploying [default: pull from lkr cli then commit and deploy]
  • --help: Show this message and exit.

lkr tools lookml deploy

Commit dev workspace and deploy Looker project to production.

Usage:

$ lkr tools lookml deploy [OPTIONS] [FOLDER_NAME]

Arguments:

  • [FOLDER_NAME]: Local folder name / Looker project ID to deploy

Options:

  • --project-id, --project TEXT: Looker project ID to deploy (if folder_name not specified)
  • --message TEXT: Commit message [default: commit and deploy from lkr cli]
  • --help: Show this message and exit.

lkr code-mode

Usage:

$ lkr code-mode [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • run

lkr code-mode run

Usage:

$ lkr code-mode run [OPTIONS]

Options:

  • --debug / --no-debug: Debug mode [default: no-debug]
  • --help: Show this message and exit.