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

# Deployment

## Prerequisites

The following are required for deploying the Agent Harness Security plug-in. Have this information available before deployment.

* HiddenLayer API key and secret. See [Create API Key](/docs/products/console/apikey_aisec_platform#create-api-key).

  * API key permissions required: **Interactions**: `read`, `write`; **Policies**: `read`; **Projects**: `read`.
  * See [AI Runtime Security](/docs/products/console/apikey_aisec_platform#api-permission-related-to-products-or-features), under API Permission Related to Products or Features table.

* Create a HiddenLayer Project ID. See [Create a Project](/docs/products/console/runtime_security_projects#create-a-project).

  * After a project is created, you can copy the ID by clicking the copy button.

    <Frame>
      <img src="https://mintcdn.com/hiddenlayer/juWnYrc47tp9n2GG/docs/products/runtime/agent_harness/images/project-id-copy.png?fit=max&auto=format&n=juWnYrc47tp9n2GG&q=85&s=769f9843d42ea47054a06d84f912ae85" alt="Log In Page" width="335" height="187" data-path="docs/products/runtime/agent_harness/images/project-id-copy.png" />
    </Frame>

## Deploy the Plug-in

1. Obtain the plug-in from HiddenLayer. Contact your HiddenLayer sales representative or support.
2. Deploy the plug-in to your endpoints.

   * For example:

     * Deploy using an MDM application, like Jamf or Microsoft Intune.
     * Manually copy the plug-in file to the endpoint.

## Configure and Hook the Plug-in

Configuring the plug-in connects it to your tenant in the HiddenLayer Console. Hooking the plug-in secures your AI coding agents. You can unhook the plug-in when needed.

1. Set the Client ID. This is the HiddenLayer API key. Replace `my-client-id` with the API key.

   ```sh theme={null}
   hl config set client_id my-client-id
   ```

2. Set the Client Secret. This is the API secret. Replace `my-client-secret` with the API secret. The secret is routed to the OS secret store. The value is not echoed.

   ```sh theme={null}
   hl config set client_secret my-client-secret
   ```

3. Set the Platform URL. This is the region for the Console that you log in to. **Note**: The following example is for the EU region. The US region is the default region.

   ```sh theme={null}
   hl config set --global platform_url https://api.eu.hiddenlayer.ai
   ```

4. Optionally, set the Project ID if you are using a project other than the default. Replace `my-project-id` with the project ID you want to use.

   ```sh theme={null}
   hl config set project_id my-project-id
   ```

5. Check the status of the plug-in to verify the current configuration.

   ```sh theme={null}
   hl status
   ```

6. Verify the configuration authentication.

   ```sh theme={null}
   hl runtime auth
   ```

7. Install the hooks for all supported harnesses.

   ```sh theme={null}
   hl runtime setup
   ```

<Note>
  **System-Level Installation**

  For system-level installation, run with `sudo`. This is supported for Copilot and Cursor.
</Note>

## Unhook the Coding Agents

1. To remove the hook configurations, run the following command.

   ```sh theme={null}
   hl runtime unsetup
   ```

## Validation

After setup, send a test command. Traffic should appear in the console filterable by `requester` / `project ID`, showing ping, tool use, write interactions, and all agent activity.