Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rojo-rbx/rojo/llms.txt

Use this file to discover all available pages before exploring further.

rojo fmt-project reads your project.json file, parses it, and writes it back with consistent JSON formatting — two-space indentation, trailing newline, and standard key ordering. Running it keeps project files readable and produces clean diffs when properties change.

Synopsis

rojo fmt-project [PROJECT]

Arguments and flags

PROJECT
string
Path to the project file or to a directory containing a default.project.json. Defaults to the current directory.

Global flags

--verbose / -v
boolean
Increase log verbosity. Pass multiple times (e.g. -vv) for more detail.
--color
string
default:"auto"
Control color output. Accepted values are auto, always, and never.

Behavior

The command edits the project file in place. It does not produce a separate output file. The content of the project is not changed — only whitespace and formatting are normalized.
rojo fmt-project requires a valid project.json. If Rojo cannot locate or parse the project file, the command exits with an error and the original file is left unchanged.

Examples

Format the project file in the current directory:
rojo fmt-project
Format a project file at an explicit path:
rojo fmt-project path/to/my-game.project.json
Add rojo fmt-project as a pre-commit hook or CI step to keep project files consistently formatted across your team.

Build docs developers (and LLMs) love