Skip to content

Update README.md to reflect changes in lkr-dev-cli installation ins… #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bwebs merged 1 commit into from
Jul 1, 2025
Merged

Update README.md to reflect changes in lkr-dev-cli installation ins… #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The `lkr` cli is a tool for interacting with Looker. It combines Looker's SDK an

## Usage

`uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). You can start using `lkr` by running `uv run --with lkr-dev-cli lkr --help`.
`uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). You can start using `lkr` by running `uv run --with lkr-dev-cli[all] lkr --help`.

Alternatively, you can install `lkr` with `pip install lkr-dev-cli` and use commands directly like `lkr <command>`.
Alternatively, you can install `lkr` with `pip install lkr-dev-cli[all]` and use commands directly like `lkr <command>`.
Comment on lines +7 to +9
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While the change to add [all] is correct, the documentation could be clearer for new users. I suggest briefly explaining what [all] is for and using distinct code blocks for the uv and pip commands. This improves readability and makes the commands easier to copy and paste.

Suggested change
`uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). You can start using `lkr` by running `uv run --with lkr-dev-cli[all] lkr --help`.
Alternatively, you can install `lkr` with `pip install lkr-dev-cli` and use commands directly like `lkr <command>`.
Alternatively, you can install `lkr` with `pip install lkr-dev-cli[all]` and use commands directly like `lkr <command>`.
`uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/).
To use `lkr` with all optional features, we recommend installing with the `[all]` extra.
You can run `lkr` on-demand with `uv`:
```bash
uv run --with lkr-dev-cli[all] lkr --help

Alternatively, you can install it with pip to use commands like lkr <command> directly:

pip install lkr-dev-cli[all]


We also have a public docker image that you can use to run `lkr` commands.

Expand All @@ -24,7 +24,7 @@ See the [prerequisites section](#oauth2-prerequisites)
Login to `lkr`

```bash
uv run --with lkr-dev-cli lkr auth login
uv run --with lkr-dev-cli[all] lkr auth login
```

- Select a new instance
Expand All @@ -37,15 +37,15 @@ You will be redirected to the Looker OAuth authorization page, click Allow. If y
If everything is successful, you will see `Successfully authenticated!`. Test it with

```bash
uv run --with lkr-dev-cli lkr auth whoami
uv run --with lkr-dev-cli[all] lkr auth whoami
```

### Using API Key

If you provide environment variables for `LOOKERSDK_CLIENT_ID`, `LOOKERSDK_CLIENT_SECRET`, and `LOOKERSDK_BASE_URL`, `lkr` will use the API key to authenticate and the commands. We also support command line arguments to pass in the client id, client secret, and base url.

```bash
uv run --with lkr-dev-cli lkr --client-id <your client id> --client-secret <your client secret> --base-url <your instance url> auth whoami
uv run --with lkr-dev-cli[all] lkr --client-id <your client id> --client-secret <your client secret> --base-url <your instance url> auth whoami
```


Expand Down Expand Up @@ -81,7 +81,7 @@ Built into the `lkr` is an MCP server. Right now its tools are based on helping
"mcpServers": {
"lkr-mcp": {
"command": "uv",
"args": ["run", "--with", "lkr-dev-cli", "lkr", "mcp", "run"]
"args": ["run", "--with", "lkr-dev-cli[all]", "lkr", "mcp", "run"]
},
"lkr-mcp-docker": {
"command": "docker",
Expand Down