> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chkk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the Chkk CLI, Cluster Connector, and MCP servers (Cursor, Claude Code).

export const cursorDeeplink = "cursor://anysphere.cursor-deeplink/mcp/install?name=Chkk%20Upgrade%20Context%20MCP&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIENIS0tfQUNDRVNTX1RPS0VOIHB1YmxpYy5lY3IuYXdzL2Noa2svY2hray1tY3AtdXBncmFkZS1jb250ZXh0OmxhdGVzdCIsImVudiI6eyJDSEtLX0FDQ0VTU19UT0tFTiI6IjxBREQgVE9LRU4%252BIn19";

<Tabs>
  <Tab title="Chkk CLI">
    <Tabs>
      <Tab title="Linux" icon="linux">
        Install a pre-built binary on Linux using the following instructions.

        ```bash theme={"dark"}
        # For AMD64 / x86_64
        [ $(uname -m) = x86_64 ] && curl -Lo ./chkk https://cli.chkk.io/download/latest/chkk-linux-amd64
        # For ARM64
        [ $(uname -m) = aarch64 ] && curl -Lo ./chkk https://cli.chkk.io/download/latest/chkk-linux-arm64
        chmod +x ./chkk
        sudo mv ./chkk /usr/local/bin/chkk
        ```

        Or using Brew with a single command.

        ```bash theme={"dark"}
        brew install chkk-io/cli/chkk
        ```
      </Tab>

      <Tab title="MacOS" icon="apple">
        Install using Homebrew on MacOS.

        ```bash theme={"dark"}
        brew install chkk-io/cli/chkk
        ```

        Or install a pre-built binary using the following instructions.

        ```bash theme={"dark"}
        # For Intel Macs
        [ $(uname -m) = x86_64 ] && curl -Lo ./chkk https://cli.chkk.io/download/latest/chkk-darwin-amd64
        # For M1 / ARM Macs
        [ $(uname -m) = arm64 ] && curl -Lo ./chkk https://cli.chkk.io/download/latest/chkk-darwin-arm64
        chmod +x ./chkk
        mv ./chkk /some-dir-in-your-PATH/chkk
        ```
      </Tab>

      <Tab title="Windows" icon="windows">
        Install a pre-built binary on Windows in PowerShell.

        ```
        curl.exe -Lo chkk-windows-amd64.exe https://cli.chkk.io/download/latest/chkk-windows-amd64
        Move-Item .\chkk-windows-amd64.exe c:\some-dir-in-your-PATH\chkk.exe
        ```
      </Tab>
    </Tabs>

    Run the interactive starter to authenticate and optionally register clusters:

    ```bash theme={"dark"}
    chkk start
    ```
  </Tab>

  <Tab title="Cluster Connector">
    <Note>
      Supported install modes: <b>Helm</b>, <b>K8s YAML</b>, <b>Terraform</b>. See the full Connector page for requirements and configuration examples.
    </Note>

    <Steps>
      <Step title="Log in to the Chkk Dashboard">
        Visit **[https://app.chkk.io](https://app.chkk.io)** and sign in using one of the given methods.
      </Step>

      <Step title="Open the Add Cluster view">
        In the Chkk Dashboard, go to **Risk Ledger → Clusters** and click **Add Cluster**, located at the top right.
      </Step>

      <Step title="Choose your installation method">
        You have the option to onboard a cluster either using Helm, Kubernetes YAML, or Terraform.
      </Step>

      <Step title="Prepare prerequisites">
        Make sure outbound access to `chkk.io` and `s3.amazonaws.com` is allowed.
      </Step>

      <Step title="Installation">
        Follow the step-by-step flow for your chosen install method to install the Chkk Kubernetes Connector.
      </Step>

      <Step title="Validation">
        Ensure that all the pods in the `chkk-system` namespace are in a healthy state and that the `chkk-agent` pod runs to completion.
        On the Chkk Dashboard, you will see a Cluster card get created in the **Risk Ledger → Clusters** view.
        Once the scan completes, you will be able to see all the Operational Risks detected in your environment, broken by risk categories.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MCP Servers">
    <Tabs>
      <Tab title="Upgrade Agent">
        <Tabs>
          <Tab title="Cursor + Chkk">
            ## Prerequisites

            1. [Install Docker](https://docs.docker.com/get-docker/): Required to run the Chkk-Upgrade-Context-MCP Server.

            2. [Install Cursor](/resources/installation-guides/cursor): Required to begin generating environment-aware pull requests.

            <Steps>
              <Step title="Retrieve your Chkk Access Token">
                1) In the **Chkk Dashboard**, expand **Configure** on the left menu and click **Settings**.
                2) Select the **Tokens** tab. Here you'll see a list of all your active tokens (if any), along with options to create new ones or revoke existing ones.
                3) Click on the **clipboard** icon next to a token to copy it.

                                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/chkk-access-token.gif?s=f0f979e1e97c8531d96868a9db175c25" alt="Tokens Tab" width="1920" height="1080" data-path="images/features/chkk-access-token.gif" />
              </Step>

              <Step title="Install in Cursor via deeplink">
                Click the card below to install the Chkk Upgrade Context MCP Server in Cursor.

                <Card title="Add Chkk to Cursor" icon="plus" href={cursorDeeplink} horizontal={true}>
                  Click here to add Chkk to your Cursor
                </Card>
              </Step>

              <Step title="Configure your Chkk Access Token">
                Paste your Chkk Access Token in the `CHKK_ACCESS_TOKEN` environment variable
                in the **MCP Tool Settings** opened via the deeplink in the previous step.

                <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-install-uc-mcp.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=7d382f57e6de4cbf2975c55811abc15b" alt="Tokens Tab" width="1108" height="532" data-path="images/ai/cursor-install-uc-mcp.png" />
              </Step>

              <Step title="Verify Chkk Upgrade Context MCP Server is installed">
                Verify in **MCP Tool Settings** that Chkk Upgrade Context MCP Server is
                successfully installed and enabled. <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-uc-mcp-installed.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=c2e64240eb771281e943b0ac696f3554" alt="Tokens
                Tab" width="1116" height="316" data-path="images/ai/cursor-uc-mcp-installed.png" />
              </Step>
            </Steps>
          </Tab>

          <Tab title="Claude Code + Chkk">
            ## Prerequisites

            1. [Install Docker](https://docs.docker.com/get-docker/): Required to run the Chkk-Upgrade-Context-MCP Server.

            2. [Install Claude Code](/resources/installation-guides/claude-code): Required to begin generating environment-aware pull requests.

            3. A [Claude.ai](https://claude.ai/) (recommended) or [Anthropic Console](https://console.anthropic.com/) account

            <Steps>
              <Step title="Retrieve your Chkk Access Token">
                1) In the **Chkk Dashboard**, expand **Configure** on the left menu and click **Settings**.
                2) Select the **Tokens** tab. Here you'll see a list of all your active tokens (if any), along with options to create new ones or revoke existing ones.
                3) Click on the **clipboard** icon next to a token to copy it.

                                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/chkk-access-token.gif?s=f0f979e1e97c8531d96868a9db175c25" alt="Tokens Tab" width="1920" height="1080" data-path="images/features/chkk-access-token.gif" />
              </Step>

              <Step title="Install in Claude Code">
                Install the `Chkk-Upgrade-Context-MCP` using the Claude Code CLI:

                ```bash theme={"dark"}
                claude mcp add Chkk-Upgrade-Context-MCP --env CHKK_ACCESS_TOKEN="<CHKK_TOKEN>"  -- docker run -i --rm -e CHKK_ACCESS_TOKEN public.ecr.aws/chkk/chkk-mcp-upgrade-context:latest
                ```

                Replace `<CHKK_TOKEN>` with your Chkk Access Token.
              </Step>

              <Step title="Verify Chkk-Upgrade-Context-MCP Server is installed">
                Verify via CLI that the server is registered:

                ```bash theme={"dark"}
                claude mcp get Chkk-Upgrade-Context-MCP
                ```

                The command should return server details indicating it is installed and enabled.

                <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-mcp-setup.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=8c9d625d12d42a5fdc2db59701a14677" alt="Claude Code Chkk MCP Server" width="3010" height="414" data-path="images/ai/claude-code-mcp-setup.png" />
              </Step>
            </Steps>
          </Tab>
        </Tabs>
      </Tab>

      <Tab title="Risk Feed MCP">
        <Steps>
          <Step title="Download the MCP server">
            Download the latest Risk Feed MCP Server binary for your platform:

            <Columns cols={3}>
              <Card title="macOS" icon="apple" href="https://resources.chkk.dev/mcp/0.1.0/chkk-mcp-darwin-arm64.zip">
                Apple Silicon<br />M1/M2/M3 and newer
              </Card>

              <Card title="Linux" icon="linux" href="https://resources.chkk.dev/mcp/0.1.0/chkk-mcp-linux-arm64.zip">
                ARM 64-bit servers
              </Card>

              <Card title="Windows" icon="windows" href="https://resources.chkk.dev/mcp/0.1.0/chkk-mcp-windows-amd64.zip">
                Intel/AMD 64-bit PCs
              </Card>
            </Columns>

            After downloading:

            1. Unzip the downloaded binary
            2. (macOS/Linux) Make the binary executable:

            ```bash theme={"dark"}
            chmod +x ./chkk-mcp-*
            ```
          </Step>

          <Step title="Wire it into Cursor">
            In your repo, create or edit <code>.cursor/mcp.json</code> (example for macOS Apple Silicon):

            ```json theme={"dark"}
            {
              "mcpServers": {
                "chkk-mcp-stdio": {
                  "command": "./bin/chkk-mcp-darwin-arm64",
                  "args": ["serve"]
                }
              }
            }
            ```
          </Step>

          <Step title="Start & test">
            Cursor will launch the server automatically and prompt you to enable the tool. Start a chat and try a simple risk lookup to confirm.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>