Skip to main content
Deploy hooks to developer machines to gain real-time control over shadow MCP servers.

Installation Options

OptionBest ForDescription
Manual InstallationTesting, individual devicesRun CLI command directly on a device
MDM DeploymentEnterprise deploymentDeploy via SimpleMDM or Jamf Pro

Manual Installation

For testing or individual device setup, install hooks directly using the Runlayer CLI.

Prerequisites

  • The uv package manager installed (see below)
  • Access to your Runlayer instance

Installing UV

The Runlayer CLI runs using uvx (part of the uv package manager). macOS/Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh
Windows (PowerShell):
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Installing Hooks

uvx runlayer setup hooks --install --yes --host https://your-runlayer-instance.com
Options:
FlagDescription
--installPerform the installation
--yesSkip confirmation prompts
--hostYour Runlayer instance URL
--client cursorInstall hooks only for Cursor (default: all supported clients)

Verifying Installation

After installation, verify hooks are active:
uvx runlayer setup hooks --status

Uninstalling Hooks

To remove hooks from a device:
uvx runlayer setup hooks --uninstall --yes

MDM Deployment

For enterprise-wide deployment, use your MDM solution to install hooks across all developer machines. We provide step-by-step guides with interactive script generators for popular MDM platforms:

Creating an Enrollment Key

Enrollment keys allow devices to automatically register with Runlayer and obtain API credentials. You’ll need one before deploying via MDM. Enrollment Keys List
1

Navigate to Enrollment Keys

Go to Settings in the Runlayer dashboard and select the Enrollment Keys tab
2

Create a New Key

Click + Create Enrollment KeyCreate Enrollment Key
3

Configure the Key

  • Name (required): Enter a descriptive name (e.g., “Production MDM”)
  • Description (optional): Add context about the key’s purpose
4

Copy the Key

Copy the generated key (starts with rl_enroll_) and store it securelyEnrollment Key Created
Enrollment keys are shown only once. Store them securely and treat them like passwords.

Troubleshooting

Quick fixes:
  1. Verify hooks are installed: uvx runlayer setup hooks --status
  2. Restart the client application after installation
  3. Check that the client is supported (currently Cursor on macOS)
  4. Ensure the hooks are installed for the correct client
Quick fixes:
  1. Ensure uv is installed: curl -LsSf https://astral.sh/uv/install.sh | sh
  2. Check network connectivity to your Runlayer instance
  3. Verify the host URL is correct
  4. Try running with verbose output for more details
Quick fixes:
  1. Check your Runlayer instance connectivity
  2. Review the number of policies being evaluated
  3. Contact Runlayer support if issues persist