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
1
Install Stud
Clone the repository and install dependencies:
Terminal
git clone https://github.com/improdead/stud.git
cd stud
bun install2
Configure your API key
Set your API key as an environment variable:
Terminal
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.
3
Install the Roblox Studio plugin
To use Roblox integration features, install the companion plugin:
Terminal
# 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.
4
Launch Stud
Start Stud in your project directory:
Terminal
bun run startYour first prompt
Once Stud is running, try a simple prompt to explore your codebase:
stud> Read my project structure and summarize what each file does
✱Glob "**/*"23 files
→Read src/server/init.lua142 lines
→Read src/client/PlayerGui.lua89 lines
~Reading remaining files...