Skip to content

CLI Reference

The main entry point for the Tungsten CLI.

FlagDescription
-V, --versionPrints the current version of Tungsten.
-H, --helpPrints a list of available commands and their usage.

Initializes a new tungsten.toml configuration file and updates your .gitignore file in the current directory.

tungsten init

Validates your tungsten.toml configuration and ensures all assets referenced in your input globs are accessible.

tungsten test --api-key <key>
FlagValueDescription
--api-keystringOptional: Provides your Open Cloud API key to verify connection health with Roblox.

The primary command for syncing your local assets to Roblox and generating project-specific Luau modules.

tungsten sync <target> [flags]
TargetDescription
cloudUploads assets directly to the Roblox Open Cloud API.
studioSyncs assets to your local Roblox Studio instance.
debugCreates a .tungsten_debug folder, allowing you to inspect the final output before upload.
FlagValueDescription
--api-keystringProvides your Open Cloud API key for authentication.
--dry-runbooleanSimulates the entire sync process without uploading or modifying remote assets.

Starts a long-running process that watches your assets folder for changes. When a file is modified, added, or deleted, Tungsten automatically performs a sync.

tungsten watch <target> [flags]
TargetDescription
cloudUploads assets directly to the Roblox Open Cloud API.
studioSyncs assets to your local Roblox Studio instance.
debugCreates a .tungsten_debug folder, allowing you to inspect the final output before upload.
FlagValueDescription
--api-keystringProvides your Open Cloud API key for authentication.