Command Reference

Getting Help

The command gzr help will display the available commands. The command gzr COMMAND help will display the subcommands for that particular command. The command gzr COMMAND help SUBCOMMAND will show the details for that subcommand.

Managing Spaces

Listing the Contents of a Space

gzr space ls [FILTER_SPEC] --host=looker.example.com will retrieve information about a space. The FILTER_SPEC can support multiple types of values.

When the FILTER_SPEC is not included, this command will display the contents of the current user's default home space. This is the user's default space.

When FILTER_SPEC is "~" the space listed will be the user's personal space.

When the FILTER_SPEC is "~123" or "~John Smith", the space listed will be the personal space of user 123 or the user(s) named "John Smith".

When the FILTER_SPEC is a title like "Daily Reports" the spaces will be searched for a space or spaces with that title, and those spaces will be listed.

When the FILTER_SPEC is a number like "100", the space with id 100 will be listed.

Fetching Top Level or Root Spaces

The command gzr space top --host=looker.example.com displays the top level spaces for a server. This will normally be 'Shared' and 'Users' but in "closed systems" there may be others defined.

Display the Space Hierarchy in a Tree

The command gzr space tree [FILTER_SPEC] --host=looker.example.com displays a space and all its subspaces, dashboards, and looks in a tree format. The FILTER_SPEC follows the same rules as for gzr space ls.

Delete a Space

gzr space rm SPACE_ID --host=looker.example.com

Create a Space

gzr space create NAME PARENT_SPACE_ID --host=looker.example.com

Display Space Details

gzr space cat SPACE_ID --host=looker.example.com

Export a Space

gzr space export SPACE_ID --host=looker.example.com

Managing Looks

Display Look Details

gzr look cat LOOK_ID --host=looker.example.com

Delete a Look

gzr look rm LOOK_ID --host=looker.example.com

Import a Look

gzr look import FILE DEST_SPACE_ID --host=looker.example.com

Managing Dashboards

Display Dashboard Details

gzr dashboard cat DASHBOARD_ID --host=looker.example.com

Delete Dashboard

gzr dashboard rm DASHBOARD_ID --host=looker.example.com

Import a Dashboard

gzr dashboard import FILE DEST_SPACE_ID --host=looker.example.com

Managing Scheduled Plans

List All Scheduled Plans

gzr plan ls --host=looker.example.com

Display Scheduled Plan Details

gzr plan cat PLAN_ID --host=looker.example.com

Delete Scheduled Plan

gzr plan rm PLAN_ID --host=looker.example.com

Import Scheduled Plan

Import Scheduled Plan For a Look

gzr plan import PLAN_FILE look LOOK_ID --host=looker.example.com

Import Scheduled Plan For a Dashboard

gzr plan import PLAN_FILE dashboard DASHBOARD_ID --host=looker.example.com

Displaying User Information

List All Users

gzr user ls --host=looker.example.com

Display the Current User

gzr user me --host=looker.example.com

Display Details of a User

gzr user cat USER_ID --host=looker.example.com

Disable a User

gzr user disable USER_ID --host=looker.example.com

Displaying Group Information

List All Groups

gzr group ls --host=looker.example.com

List Users In a Group

gzr group member_users GROUP_ID --host=looker.example.com

List Groups In a Group

gzr group member_groups GROUP_ID --host=looker.example.com

Displaying Connection Information

List All Connections

gzr connection ls --host=looker.example.com

List All Dialects

gzr connection dialects --host=looker.example.com

Displaying Model Information

List All Models

gzr model ls --host=looker.example.com