Skip to content
File systemReference

renamefile

Rename or relocate a workspace file or folder.

Details#

Rename or relocate a workspace file or folder. No return values.

Signature#

Luau
renamefile(source: string, destination: string): ()

Parameters#

ParameterTypeDescription
sourcestringExisting workspace-relative source path.
destinationstringWorkspace-relative target path.

Returns#

No return values.

Examples#

Local example

Luau
writefile("docs-example/original-renamefile.txt", "local note")
renamefile("docs-example/original-renamefile.txt", "docs-example/result-renamefile.txt")