Documentation

Everything you need to connect your AI assistant to your team.

Getting Started

Install the NokAI CLI globally with npm:

npm install -g @nokai/cli

Configure NokAI using environment variables. Only NOKAI_SIGNALING_URL is required.

Advanced: For self-hosted deployments, additional relay configuration variables (NOKAI_TURN_SERVER, NOKAI_TURN_USERNAME, NOKAI_TURN_PASSWORD) are available. See the GitHub README for details.

Connecting

Your NokAI ID

When NokAI starts, you get a permanent ID (like AnyDesk). Share it with teammates so they can connect to you.

[NokAI] Your NokAI ID: NKI-8A3F-K2M9
[NokAI] Session: my-project (sess_a1b2c3d4)

Connect to a Teammate

nokai_connect mode=teammate id=NKI-D7F2-B4E1
→ Connection request sent. Waiting for approval...

Teammate sees: Approval code: 4827
Teammate tells you the code → Connected!

Connect Your Own Projects

Working on multiple projects? Connect your AI sessions to each other — no approval needed.

nokai_connect mode=self
→ Available sessions: web-frontend, mobile-app

nokai_connect mode=self session=web-frontend
→ Connected to your session: web-frontend!

Claude Code

Add NokAI as an MCP server in your Claude Code settings. Open your Claude Code configuration and add the following to your MCP servers block:

{
  "mcpServers": {
    "nokai": {
      "command": "nokai",
      "env": {
        "NOKAI_AGENT_NAME": "YourName",
        "NOKAI_SIGNALING_URL": "wss://your-server.workers.dev"
      }
    }
  }
}

Claude Code will automatically discover and connect to the NokAI MCP server on next launch.

Cursor

Create or edit .cursor/mcp.json at the root of your project (or in your home directory for a global config):

{
  "mcpServers": {
    "nokai": {
      "command": "nokai",
      "env": {
        "NOKAI_AGENT_NAME": "YourName",
        "NOKAI_SIGNALING_URL": "wss://your-server.workers.dev"
      }
    }
  }
}

Restart Cursor after saving the file. The NokAI tool will appear in the MCP tools panel.

Windsurf

Edit ~/.codeium/windsurf/mcp_config.json to register NokAI as an MCP server:

{
  "mcpServers": {
    "nokai": {
      "command": "nokai",
      "env": {
        "NOKAI_AGENT_NAME": "YourName",
        "NOKAI_SIGNALING_URL": "wss://your-server.workers.dev"
      }
    }
  }
}

Windsurf will pick up the new configuration on the next session start.

VS Code Extension

The NokAI VS Code extension provides a one-click setup experience. Follow these steps:

1. Install the extension — search for NokAI in the VS Code Extensions marketplace and click Install.
2. Open Settings — go to File › Preferences › Settings (or press ⌘,) and search for nokai.
3. Set the signaling URL — enter your NOKAI_SIGNALING_URL in the NokAI: Signaling URL field.
4. Auto-starts with VS Code — once configured, the NokAI agent starts automatically every time VS Code opens, no extra steps required.