# Vault Loader File Staging Command Line Tool Reference

Use the command line arguments and parameters in this reference to manage your Vault's file staging. This article lists actions and parameters available in the Vault Loader file staging command line tool. For information on getting started with the Vault Loader command line tool, including installation and authentication, see <a href="/en/gr/26627/">Using the Vault Loader Command Line Tool</a>. For information on using the Vault Loader command line tool to to load data to your Vault or extract data from your Vault in bulk, see the <a href="/en/gr/67332/">Vault Loader Command Line Tool Reference</a>.

* * *

## File Staging Basics

When managing your Vault's file staging:

  * To view the root folder on file staging, you must have the standard _Vault Owner_ or _System Admin_ security profile. Non-Admin users with a security profile that grants the _Application:_ _File Staging: Access_ permission can view and manage items in a personal folder.
  * When outputting a list of items on file staging, Vault places the CSV output file in the same directory as your VaultDataLoader.jar file.
  * When uploading items, place files in the same directory as your VaultDataLoader.jar file.

## List Items {#list-items}

List files and folders on your Vault's file staging. You can specify the path to the folder to begin the listing. If omitted, the listing begins at the root (for Admin users) or user folder (for non-Admin users). If results are not output to a CSV file, Vault displays up to 25 items at a time. Press the spacebar followed by enter to see the next 25 items. This pagination option expires after 20 minutes.

<table class="wbord">
  <tr>
    <td width="20%">
      <strong>Action</strong>
    </td>
    <td width="20%">
      <strong>Parameters</strong>
    </td>
    <td width="60%">
      <strong>Example</strong>
    </td>
  </tr>
  <tr>
    <td>
      -ls [PATH]
    </td>
    <td>
      <p>
        -R
      </p>
      <p>
        -l
      </p>
      <p>
        -output [FILENAME]
      </p>
      <p>
        -outputoverwrite [FILENAME]
      </p>
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -ls u123456/cholecap_files
      </p>
      <p>
        -R
      </p>
      <p>
        -l
      </p>
      <p>
        -output cholecap_files.csv
      </p>
    </td>
  </tr>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -ls
      </p>
      <p>
        -outputoverwrite cholecap_files.csv
      </p>
    </td>
  </tr>
</table>

## Create a Folder {#create-folder}

Create one or more folders at a given path on your Vault's file staging.

<table class="wbord">
  <tr>
    <td width="20%">
      <strong>Action</strong>
    </td>
    <td width="20%">
      <strong>Parameters</strong>
    </td>
    <td width="60%">
      <strong>Example</strong>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -mkdir [PATH]
      </p>
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -mkdir Folder1 /u123456/Folder2
      </p>
    </td>
  </tr>
</table>

## Upload a File or Folder {#upload-item}

Upload files or folders to file staging.

<table class="wbord">
  <tr>
    <td>
      <p>
        <strong>Action</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Parameters</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Example</strong>
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -put [ITEM]
      </p>
    </td>
    <td>
      <p>
        -parent [FOLDER]
      </p>
      <p>
        -overwrite
      </p>
      <p>
        -R
      </p>
      <p>
        -concurrent [NUMBER]
      </p>
      <p>
        -output [FILENAME]
      </p>
      <p>
        -outputoverwrite [FILENAME]
      </p>
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -put cholecap_files
      </p>
      <p>
         -parent u123456/Cholecap_folder
      </p>
      <p>
        -R
      </p>
      <p>
        -concurrent 5
      </p>
      <p>
        -output cholecap_files_upload_progress.txt
      </p>
    </td>
  </tr>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -put nyaxa_files
      </p>
      <p>
         -parent u123456/Nyaxa_folder
      </p>
      <p>
        -outputoverwrite nyaxa_files_upload_progress.txt
      </p>
    </td>
  </tr>
</table>

## Download Files or Folders {#download-item}

Download one or more files or folders from file staging.

<table class="wbord">
  <tr>
    <td>
      <p>
        <strong>Action</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Parameters</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Example</strong>
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -get [ITEM]
      </p>
    </td>
    <td>
      <p>
        -downloadpath [PATH]
      </p>
      <p>
        -overwrite
      </p>
      <p>
        -R
      </p>
      <p>
        -concurrent
      </p>
      <p>
        -output
      </p>
      <p>
        -outputoverwrite
      </p>
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -get cholecap_files
      </p>
      <p>
        -downloadpath Desktop/Cholecap_folder
      </p>
      <p>
        -R
      </p>
      <p>
        -concurrent 5
      </p>
      <p>
        -output cholecap_files_download_progress.csv
      </p>
    </td>
  </tr>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -get nyaxa_files
      </p>
      <p>
        -outputoverwrite nyaxa_files_download_progress.csv
      </p>
    </td>
  </tr>
</table>

## Rename a File or Folder {#rename}

Change the name of an existing file or folder.

<table class="wbord">
  <tr>
    <td>
      <p>
        <strong>Action</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Parameters</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Example</strong>
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -rename [ITEM] [NEWITEM]
      </p>
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -rename holecap_files cholecap_files
      </p>
    </td>
  </tr>
</table>

## Move a File or Folder {#move}

Move an existing file or folder.

<table class="wbord">
  <tr>
    <td>
      <p>
        <strong>Action</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Parameters</strong>
      </p>
    </td>
    <td>
      <p>
        <strong>Example</strong>
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -move [ITEM] [PATH]
      </p>
    </td>
    <td>
      <p>
        -overwrite
      </p>
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -move nyaxa_files/cholecap.pdf
      </p>
      <p>
        cholecap_files
      </p>
      <p>
      </p>
      <p>
        -overwrite
      </p>
    </td>
  </tr>
</table>

## Delete a File or Folder {#delete}

Delete one or more files or folders at a given path on your Vault's file staging. Use the -R parameter on a specified folder to remove all of its contents recursively, including files and subfolders.

<table class="wbord">
  <tr>
    <td width="20%">
      <strong>Action</strong>
    </td>
    <td width="20%">
      <strong>Parameters</strong>
    </td>
    <td width="60%">
      <strong>Example</strong>
    </td>
  </tr>
  <tr>
    <td>
      <p>
        -rm [PATH]
      </p>
    </td>
    <td>
      <p>
        -R
      </p>
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -rm  /u123456/cholecap.docx /nyaxa.txt
      </p>
    </td>
  </tr>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>
      &nbsp;
    </td>
    <td>
      <p>
        java -jar VaultDataLoader.jar -rm /folder1 /folder2/subfolder3
      </p>
      <p>
        -R
      </p>
    </td>
  </tr>
</table>

## File Staging Parameters {#parameters}

<table class="wbord" style="height: 315px;">
  <tr style="height: 23px;">
    <td style="height: 23px; width: 159.659px;">
      <strong>Parameter</strong>
    </td>
    <td style="height: 23px; width: 943.295px;">
      <strong>Description</strong>
    </td>
  </tr>
  <tr style="height: 55px;">
    <td style="height: 55px; width: 159.659px;">
      <p>
        -R
      </p>
    </td>
    <td style="height: 55px; width: 943.295px;">
      <p>
        Use this flag to apply an action to all files and subfolders in a folder.
      </p>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <p>
        -l
      </p>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <p>
        Use this flag with the <a href="#list-items">List Items</a> action to return results in long format, including kind, name, path, size (for files only), and modified date (for files only). If omitted, the default is short format.
      </p>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <p>
        -output [FILENAME]
      </p>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <p>
        Use this flag to output results to a csv file with a specified name. Once generated, Vault places this file in the same directory as your VaultDataLoader.jar file.
      </p>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <p>
        -outputoverwrite [FILENAME]
      </p>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <p>
        Use this flag to overwrite an existing output file.
      </p>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      -parent
    </td>
    <td style="height: 79px; width: 943.295px;">
      <span style="font-weight: 400;">When using the <a href="#upload-item">Upload a File or Folder</a> action, this flag is</span> <span style="font-weight: 400;">required</span><span style="font-weight: 400;"> and specifies the path to the parent directory to place the uploaded files or folders.</span>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <span style="font-weight: 400;">-concurrent</span>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <span style="font-weight: 400;">Use this</span> <span style="font-weight: 400;">flag</span><span style="font-weight: 400;"><span style="font-weight: 400;"> with the<a href="#upload-item"> Upload a File or Folder</a> or</span> </span><span style="font-weight: 400;"><a href="#download-item">Download Files or Folders</a> action to specify the number of concurrent uploads or downloads, which can be between 1 and 10.</span>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <span style="font-weight: 400;">-downloadpath</span>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <span style="font-weight: 400;">Use this flag with the <a href="#download-item">Download Files or Folders</a> action to specify the path to the folder in which to place the download. If omitted, Vault places the files in the "filedownloads" subfolder of</span><span style="font-weight: 400;"> the directory containing your VaultDataLoader.jar file.</span>
    </td>
  </tr>
  <tr style="height: 79px;">
    <td style="height: 79px; width: 159.659px;">
      <span style="font-weight: 400;">-overwrite</span>
    </td>
    <td style="height: 79px; width: 943.295px;">
      <span style="font-weight: 400;">Use this flag with the <a href="#move">Move a File or Folder</a> action to overwrite an existing item with the same name. If omitted, the default is not to overwrite.</span>
    </td>
  </tr>
</table>