file:list

Lists the files in the File Cabinet of your account.

Note:

You cannot list the files from a SuiteApp.

Syntax

            file:list <--folder FileCabinetPath1> 

          

Options

Option

Required / Optional

Description

--folder

Required

Specifies the File Cabinet path that contains the files to list. For example, "/SuiteScripts".

In addition, all files within subfolders are included.

-i or--interactive

Optional

Runs the command in interactive mode.

-h or --help

Optional

Prints the help for this command.

Interactive Example

The following command lists the files in a specific folder using the interactive mode:

            suitecloud file:list -i 

          

Before the command is executed, the following questions are prompted:

            Select the File Cabinet folder for which you want to get a file list. All files within subfolders will be included in the listing.
 (*) \SuiteScripts
 ( ) \SuiteScripts\RunTimeFiles 

          

Non-interactive Example

The following command lists the files in the SuiteScripts folder of the File Cabinet of your account:

            suitecloud file:list --folder "/SuiteScripts" 

          

Output Example

When executed, the command produces output that is similar to the following:

            The following files were found in your account:
/SuiteScripts/file1.js
/SuiteScripts/file2.js
/SuiteScripts/file3.js
/SuiteScripts/file4.js
/SuiteScripts/RunTimeFiles/document.pdf
/SuiteScripts/RunTimeFiles/data.csv
/SuiteScripts/RunTimeFiles/log.txt
/SuiteScripts/RunTimeFiles/sample.txt
/SuiteScripts/RunTimeFiles/test.xml 

          

Related Topics

General Notices