> For the complete documentation index, see [llms.txt](https://docs.keyshade.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyshade.io/getting-started/installing-the-cli.md).

# Installing the CLI

The Keyshade CLI serves as the entrypoint for your projects and apps to use Keyshade. Currently, our CLI binary is hosted over the npm registry, and it can be installed by running the following command:

## Installation

{% tabs %}
{% tab title="MacOS" %}

```shell
brew tap keyshade-xyz/keyshade https://github.com/keyshade-xyz/keyshade
brew install keyshade
```

{% endtab %}

{% tab title="Windows" %}

```shell
scoop bucket add keyshade https://github.com/keyshade-xyz/keyshade.git
scoop install keyshade
```

{% endtab %}

{% tab title="npm" %}

```shell
npm i -g @keyshade/cli
```

{% endtab %}

{% tab title="pnpm" %}

```shell
pnpm i -g @keyshade/cli
```

{% endtab %}

{% tab title="bun" %}

```shell
bun i -g @keyshade/cli
```

{% endtab %}
{% endtabs %}

That's it! You now have Keyshade installed on your system.

To verify the installation, you can run the following command:

```sh
keyshade --version
```

This should print the version of the Keyshade CLI installed on your system.

![keyshade-cli](/files/EARnMmwVGEjtoWd64WFq)

*(Version shown here is `3.0.1`, but yours may differ depending on installation time or updates.)*

## Authenticate the CLI

Keyshade allows you to perform a secure login directly from your CLI. Once authenticated successfully, you would have your profile configured locally. To begin, run this command:

```shell
keyshade login
```

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FklyYIOuyG5AKyh2FIsOK%2Fuploads%2Fl3JCFYHob9Ojrr6D1rtI%2Flogin.mp4?alt=media&token=78d2fba9-2bc5-4259-973d-0328466fa9d9>" %}

This will ask you for your email—the one that you used earlier to sign up to keyshade, and a deployment URL. In case you are using a self-hosted deployment, you would need to provide the base URL of your API (example - `https://keyshade-api.mydomain.com`). Otherwise, you can skip this step.

Next, enter the sign-in code that you received in your email.

And that's it! You are all set to use the CLI.

## Test your profile

You can run this command to check if your profile is set up correctly:

```shell
keyshade workspace list
```

This command should output a list of all the workspaces that you have access to. If you have just started, there should be only one workspace.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.keyshade.io/getting-started/installing-the-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.