Getting Started

Install and set up nokey.ai in minutes to secure your AI coding workflow

Installation

nokey.ai can be installed with a single command on macOS, Linux, and Windows.

macOS and Linux

curl -fsSL https://nokey.ai/install.sh | bash

Windows (PowerShell)

iwr -useb https://nokey.ai/install.ps1 | iex

Note: The installer will automatically detect your operating system and architecture, download the appropriate binary, and add it to your PATH.

Verify Installation

After installation, verify that nokey is properly installed:

nokey --version

You should see the version number printed to the console.

First Run

Once installed, nokey works automatically with your AI coding assistant. No configuration needed!

1

Open your AI IDE

Launch Claude Code, Cursor, or any other AI-powered coding assistant.

2

Start coding

Code normally with AI assistance. nokey automatically intercepts and blocks access to sensitive files.

3

Review audits

When AI requests access to secrets, you'll be notified and all requests are logged.

What Gets Protected?

By default, nokey protects common secret files and patterns:

  • .env and .env.* files
  • credentials.json, secrets.yaml
  • ~/.ssh/ directory (SSH keys)
  • ~/.aws/credentials
  • API keys and tokens in configuration files
  • Private keys and certificates

See Configuration to customize which files are protected.

Viewing Audit Logs

Check what AI has accessed:

nokey logs

This shows a timeline of all AI access requests, including which files were requested and whether access was granted or denied.

Next Steps

Having Issues?

Check out our Troubleshooting Guide or report an issue on GitHub.