Understanding Dry-Run Mode for Safety
Dry-run mode is one of the most important safety features you will encounter. All file write operations simulate changes by default. You see exactly what would happen, but your files stay untouched until you give explicit permission.
What happens during a dry run:
- GameCatalyst validates the command and parameters
- Checks permissions, paths, and safety rules
- Simulates the operation
- Returns a detailed report
- Makes zero changes to your files
Example response: [DRY RUN] Would create file at Assets/Scripts/Player.cs (1,245 bytes). Parent directory exists. No conflicts.
Why dry-run is default: File operations are permanent. Deleting wrong files or overwriting code ruins hours of work. Dry-run gives you a preview every time.
Executing for real: Tell Vex: “Create the script with dry_run false.” Vex sets dry_run: false and the file is actually created.
Disabling globally: Dashboard Settings Advanced tab has dry_run_default. Set to false if you want all operations to execute immediately. Use with caution.
Which commands use it: All write operations — file.create, file.edit, file.delete, file.copy, file.move, file.rename, file.duplicate, folder.create, folder.delete, folder.copy, folder.move, folder.rename, folder.duplicate. Read operations (file.read, folder.read, file.info) never use dry-run because they do not modify anything.
Dry-run in workspace plans:
When Vex works through a workspace plan, dry-run mode gives you an extra safety layer. Each file operation in the plan shows what would happen before executing. If plan approval is enabled, you can review all the dry-run previews before giving Vex the go-ahead to execute with dry_run: false. This combination of plan approval and dry-run preview gives you complete visibility and control over multi-step file operations.
When Vex disables dry-run:
Once you confirm a file operation should execute for real, Vex sets dry_run: false on the command. This is explicit and intentional — Vex never silently disables dry-run mode on its own. If you told Vex to create a script and Vex shows the dry-run preview, you say “go ahead, create it for real” and Vex re-runs the command with dry-run disabled.
Best practice:
Leave dry-run enabled globally (the default). Let Vex show you previews for important operations. Only disable it globally if you are doing rapid prototyping where the preview step slows you down. You can always re-enable it from Dashboard Settings Advanced tab at any time.
