StudSTUD/Docs

Documentation

Build faster with Stud, from first prompt to shipped update.

This docs hub gives you everything: setup, tool behavior, permission controls, and Roblox Studio workflows. Use it as both a first-day guide and an everyday reference.

Start in 5 minutesBrowse tools

Time to first run

~5 min

Roblox toolset

27+ tools

Control model

Permission-first

Choose your guide

Jump directly to what you need right now, then come back to fill in the rest. Each guide is written to be practical, not theoretical.

Getting Started

Install Stud, connect your model provider, and run your first session in under five minutes.

  • Requirements and setup
  • Plugin installation
  • First prompt walkthrough

Tools Reference

Understand every core tool: read, write, edit, search, shell execution, and subagent workflows.

  • Tool-by-tool examples
  • Parameters and outputs
  • When to use each tool

Permissions

Learn how approvals work so you can keep full control over file edits, commands, and Studio actions.

  • Allow once vs always
  • Safe defaults
  • Session best practices

Roblox Integration

Go deep with 27+ Studio-aware tools for scripts, instances, DataStores, and Toolbox workflows.

  • Studio plugin connection
  • Roblox tool families
  • Real-world command examples

Recommended path

Fast track to productive sessions

1

Install and launch

Clone the repo, install dependencies, and start Stud in your project directory.

Setup guide
2

Learn your core tools

Master Read, Edit, Glob, Grep, and Bash so your prompts translate into precise execution.

Tools reference
3

Tune permissions

Configure approval behavior for safer automation and smoother day-to-day sessions.

Permission model
4

Connect Roblox Studio

Enable the plugin and unlock script edits, instance actions, DataStore access, and toolbox flows.

Roblox docs

Command quickstart

Copy-ready essentials

Install

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

Set API key

export ANTHROPIC_API_KEY="your-api-key"

Start session

bun run start

What you can ask Stud

Strong prompts combine intent, constraints, and expected output. These examples are a solid starting point for common workflows.

Explore a codebase

Use this when onboarding to an unfamiliar project.

  • Map this project structure and summarize each directory.
  • Find where authentication is implemented and explain the flow.
  • List every API endpoint and show where each is used.

Implement features

Guide Stud with intent, constraints, and expected output.

  • Add a cooldown system for abilities and include tests.
  • Create a reusable health bar component with mobile support.
  • Refactor this module for readability without changing behavior.

Ship Roblox updates

Blend CLI code edits with Studio-side operations.

  • Create a round manager in ServerScriptService and wire RemoteEvents.
  • Search Toolbox for a medieval village set and insert top two results.
  • Inspect DataStore key user_123 and add migration logic if needed.

Frequently asked questions

Do I need Roblox Studio to use Stud?

No. Stud works as a general coding assistant for any project. Roblox Studio is only required if you want the Studio-specific tools.

Does Stud run actions without me?

Stud asks for approval before sensitive actions like writes, shell commands, and Studio mutations. You stay in control of every session.

Can I use different model providers?

Yes. Stud is model-flexible. Configure your provider key and settings, then choose the model workflow that fits your task and budget.

What should I include in a great prompt?

Describe the goal, constraints, and acceptance criteria. Add context like file paths, expected behavior, and whether tests should be updated.

Ready to build with Stud?

Start with the setup guide, then move into tools and Roblox integration. Keep this page bookmarked as your docs command center.

Open setup guideExplore Roblox docs