HAWKNET DOCS

Getting Started

Get Hawknet running in under five minutes.

You will need a license key first. Grab one from the product page if you have not already.

1. Install Hawknet

Run a single command in your terminal:

$ curl -sSfL https://hawknet.cloud.whitehawkgroup.net/install.sh | sh

The installer asks which edition you want, then prompts for your license key and sets up everything:

  • The hawknet daemon at ~/.hawknet/bin/hawknet
  • The Roblox Studio plugin (auto-detected, including Vinegar on Linux)
  • Embedded tools (luau-lsp, selene, stylua)
  • MCP configuration for all detected AI clients

Editions

EditionWhat you getUpdates
Roblox (recommended)The stable Roblox Studio toolsetStable channel
ExperimentalRoblox plus early-access Blender, KiCad, FreeCAD, and Aseprite toolsExperimental channel

Both editions use the same license. The experimental edition is a preview build: the extra editor tools are early access and not everything works as intended yet. The Roblox toolset inside it is the same code as stable. Pick Roblox unless you want the creative-tool integrations today.

Switch editions anytime; the swap is immediate and keeps your license and settings:

hawknet edition stable        # back to the Roblox edition
hawknet edition experimental  # opt in to the preview

Non-interactive installs default to Roblox; set HAWKNET_UPDATE_CHANNEL=experimental before running the installer to script the experimental choice.

Uninstalling

hawknet uninstall removes everything Hawknet put on your machine: the Studio plugin and editor add-ons, MCP entries in your AI clients, stored credentials, state directories, the installer’s PATH entry, and the binary itself. It also deactivates this device so the license slot frees up for another machine.

Supported clients: Claude Code, Claude Desktop, Cursor, Codex CLI, OpenCode, and Google Antigravity. The installer writes config to ~/.claude.json, ~/.cursor/mcp.json, ~/.codex/config.toml, and their equivalents.

2. Connect to Studio

  1. Open Roblox Studio with any place file.
  2. The Hawknet plugin appears in the toolbar automatically after install.
  3. A small dock widget shows the connection status: Connected or Disconnected.
  4. If it does not connect on its own, click Reset Hawknet in the plugin toolbar.

Hawknet handles the daemon and Studio plugin connection automatically. No manual network setup should be needed for a normal install.

3. Start Your AI Client

After the first install, restart your AI client so it picks up the new MCP configuration.

Open Claude Code, Cursor, or whichever client you use. Hawknet connects automatically on startup. You are ready to go — just start talking.

Try these to get a feel for it:

  • “Show me what scripts are in ServerScriptService”
  • “Create a basic combat system”
  • “Fix the bug in my inventory module”

Your AI can read scripts, create instances, run code, and much more — all directly inside Studio.

4. Optional: Initialize a Project (Experimental)

Hawknet works without any project setup. But if you want file sync between your filesystem and Studio, you can initialize a project. This feature is experimental.

hawknet init ./my-project --name MyGame

This runs an interactive setup that asks for:

  • Project name
  • Mapping style
  • Monorepo mode
  • Whether to git init

It pulls all scripts from Studio to your filesystem and creates a hawknet.toml config file. The .hawknet/ directory is automatically added to your global gitignore.

What’s Next