Roport CLI

Roport is a next-generation sync tool for Roblox, designed to be AI-friendly and feature-rich. It allows you to sync scripts, models, and assets between your local file system and Roblox Studio.

Features

• Full Two-Way Sync: Edit in VS Code, see changes in Studio. Rename in Studio, see changes in VS Code.
• AI-Optimized:
  • roport context: Generates a token-efficient summary of your project for AI context.
  • .model.json: Define complex Roblox instances (Parts, UIs, Constraints) using simple JSON.
• Scalable: Handles large projects with batching and streaming.
• Robust: Safe renaming, binary file support, and ignore file support (.gitignore, .rojoignore).

Installation

npm install -g roport

Usage

1. Initialize a Project

mkdir MyGame
cd MyGame
roport init

2. Install the Plugin

roport plugin install

Restart Roblox Studio after installing.

3. Start the Server

roport serve

4. Connect in Studio

Open the Roport plugin in Roblox Studio and click Connect.

Commands

• roport serve: Start the sync server.
• roport build -o <file.rbxmx>: Build the project into a model file.
• roport context: Generate a project summary for AI.
• roport sourcemap: Generate a sourcemap.
• roport plugin install: Install the Studio plugin.

AI Generation Guide

See AI_GUIDE.md in your project root (created by roport init) for instructions on how to generate Roblox content using AI.