Skip to main content
Install the OneX Governance client to connect Claude Code, Cursor, and other supported assistants to your tenant. If you use GitHub Copilot in Visual Studio Code, finish this guide first, then complete GitHub Copilot in VS Code.

Requirements

ItemPurpose
Governance client packagePlatform bundle from your organization (Overview)
API URLOneX API endpoint for your tenant
Forwarder secretAuthenticates the client to your tenant
Tenant IDIdentifies your organization in OneX
Forwarder secret - Available in the OneX dashboard under your account.

Windows

Guided install

  1. Extract OneXGovernance-Portable.zip to a local folder (for example C:\OneXGovernance).
  2. Launch OneXGovernance.exe and provide:
    • API URL
    • Forwarder secret (from your account in the OneX dashboard)
    • Tenant ID
    • Tools to register, comma-separated (for example claude_code or claude_code,copilot)
    • Logon task registration, so the client remains connected after sign-in (recommended)
  3. Close and fully restart your IDE or VS Code—a window reload is not sufficient.
  4. Exercise your assistant as you normally would, then confirm events in the governance dashboard.

Unattended install

For MDM or scripted deployment:
OneXGovernance.exe install-client -y ^
  --api-url https://onex-api.yourcompany.com ^
  --secret YOUR_SECRET ^
  --tenant your-tenant ^
  --tools claude_code ^
  --register-task
Add copilot to --tools when Visual Studio Code is in scope, then proceed to GitHub Copilot in VS Code.

Status and removal

OneXGovernance.exe status
OneXGovernance.exe install-client --uninstall
If the original zip folder was removed, run these from the installed client path reported by status.

macOS and Linux

Extract the tar.gz archive supplied by your organization and run the installer from the extracted directory:
tar -xzf OneXGovernance-linux-x86_64.tar.gz      # or OneXGovernance-macos-arm64.tar.gz
cd OneXGovernance

# macOS: if Gatekeeper blocks the binary, allow it under System Settings → Privacy & Security
xattr -dr com.apple.quarantine .

./OneXGovernance install-client -y \
  --api-url https://onex-api.yourcompany.com \
  --secret YOUR_SECRET \
  --tenant your-tenant \
  --tools claude_code
Validate the installation:
./OneXGovernance status
./OneXGovernance doctor
Restart your IDE, use your assistant, and confirm events in the governance dashboard. macOS may prompt for approval the first time the client runs.

Updating your tool selection

When you adopt a new assistant or upgrade the client, run install-client again with a revised --tools list:
OneXGovernance.exe install-client -y --tools claude_code,copilot
Adding copilot requires the additional steps in GitHub Copilot in VS Code. To register one tool without a full reinstall:
OneXGovernance.exe install claude_code
OneXGovernance.exe install copilot
./OneXGovernance install claude_code
./OneXGovernance install copilot

Post-install validation

Run status to confirm configuration. If the dashboard stays empty after a full IDE restart, run doctor and review Troubleshooting.