Getting Started

Installation & Setup

Get up and running with Stud in under five minutes.

Prerequisites

• Node.js 18+ — Stud requires a modern Node.js runtime
• Roblox Studio — For Roblox integration features (optional for general coding)
• An API key — From your preferred LLM provider

Install Stud

Clone the repository and install dependencies:

git clone https://github.com/stud-ai/stud.git
cd stud
bun install

Configure your API key

Set your API key as an environment variable:

export ANTHROPIC_API_KEY="your-api-key-here"

Keep your API key secure

Add your API key to your shell profile (.bashrc or .zshrc) so it persists across sessions. Never commit API keys to version control.

Install the Roblox Studio plugin

To use Roblox integration features, install the companion plugin:

# The plugin file is included in the repo
# Copy it to your Roblox Studio plugins folder:

cp plugins/stud-plugin.rbxm ~/Documents/Roblox/Plugins/

After copying, restart Roblox Studio. You should see the Stud plugin appear in the Plugins tab. Enable HTTP Requests in Game Settings → Security for the plugin to communicate with Stud.

Launch Stud

Start Stud in your project directory:

bun run start

Your first prompt

Once Stud is running, try a simple prompt to explore your codebase:

Read my project structure and summarize what each file does

✱ Glob "**/*" 23 files

→ Read src/server/init.lua 142 lines

→ Read src/client/PlayerGui.lua 89 lines

~ Reading remaining files...

Next Steps

Tools Reference → Learn about all available tools
Roblox Integration → Set up Roblox Studio tools