vvfst

Overview

A Veeva Vault File Staging Tool (vvfst) allows managing files on the Vault file staging area. It uses the File Staging REST API to access the file staging area. Like the FTP, this tool has CLI commands to upload, download, list, etc., files in the file staging area. Find out more about File Staging REST API at https://developer.veevavault.com/api/20.3/#file-staging

Features

The CLI wraps around all File Staging REST API and makes it easier for end user to consume the API. High level features are:

• Upload a directory with a single command, file of any size is handled automatically.
• Download an entire directory from staging area.
• Get listing of all files and folders in the staging area.
• Move/Delete any file/directory.
• Upload/Download with concurrent processes.
• Auto login if the session expired for uninterrupted usage.

Demo

Installation

The CLI is built for your native platform and available in the release section Release Section.

• Download the distribution as per your OS
• Extract and copy the vvfst into your accessible path
  • For linux/osx it would be /usr/local/bin
  • For windows it would be C:\Windows\System32

Note mac user
This tool is not distributed through app store hence the mac will complain about security. If you see a security dialog,

go to system preference and click on the security and allow vvfst to run

Usage

The command has self documentation

A Veeva Vault File Staging Tool (vvfst) allows managing files on the Vault file staging area. 
Find out more about this tool at https://github.com/veeva/vvfst. Find out more about File Staging 
REST API at https://developer.veevavault.com/api/20.3/#file-staging

Each command has unique functionality, and help doc is obtained by -h argument
Example:
  vvfst login -h

Usage:
  vvfst [command]

Available Commands:
  download    Download folder/files remote
  help        Help about any command
  jobs        Display list of active jobs and check status
  login       Login to the vault
  logout      logout form current cli session
  ls          List of files and folders
  mkdir       Create remote directory
  mls         List multipart upload sessions
  mrm         Delete upload sessions
  mv          Move files/folder in the remote directory
  rm          Remove files/folder remote location
  upload      Copy a file or folder to remote directory

Flags:
  -x, --debug   Enable debug
  -h, --help    help for vvfst

Use "vvfst [command] --help" for more information about a command.

Note: The configuration, such as login credential, domain and status are cached in the $HOME/.vvfst.yaml

Commands

Usage of each commands with example found here Commands

Development

If you'd like to add additional functionality and develop from scratch then, these steps are for you.

• Install the golang
• Checkout the source git checkout https://github.com/veeva/vvfst
• Run the make command make build or run other make commands as per your OS as well.

TODO

There are multiple nice to have open items

• Support multiple login like a profile
• Add progress for upload progress
• Upload/download resume from a directory
• Add config command and move flags from login to config command

License

This code serves as an example and is not meant for production use.

Copyright 2020 Veeva Systems Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0  

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language governing permissions
and limitations under the License.