DownloadFile

Downloads a file of the platform file system of the tenant to a local file.

Examples

Download a file of the default root by path:

octo-cli -c DownloadFile -p "reports/2026/report.pdf" -f "./report.pdf"

Download a file by id, replacing a local file of the same name:

octo-cli -c DownloadFile `
    -id "68e296bc1f73f259bbb10399" `
    -f "./report.pdf" `
    -o

Options

Short	Long	Required	Description
-r	--root	no	Well-known name of the folder root (default 'Files'); used with -p.
-p	--path	no	Path of the file below the root ('/'-separated). Alternative to -id.
-id	--rtId	no	Runtime id of the file. Alternative to -p.
-f	--file	no	Local target file. Default: the file name in the current directory.
-o	--overwrite	no	Overwrite the local file if it exists.

Notes

The content is streamed to the local file; it is only moved into place when the transfer is complete.