Reference
CGT
Support
Contact SupportForm Bio CLI/SDK
formbio is a high-level command line tool for managing Form Bio workflows and projects.
- Form Bio CLI/SDK
- Installing and Updating the formbio CLI tool
- Windows
- MacOS
- Linux
- Commands
- Authentication
- Login
- Logout
- Whoami
- Data Upload and Download
- List
- Upload / Download
- Create Directory
- Run Workflows on Form Bio
- Launch workflow run
- Get workflow run
- Legal Notices
The Form Bio CLI SDK is under active development and subject to change.
Installing and Updating the formbio CLI tool
To install the latest version of the formbio CLI tool or update your existing installation with the latest you can run the following depending on your operating system.
Windows
# Install via PowerShell
iwr https://cli.formbio.com/public/latest/install/windows | iexMacOS
# Install via command line
curl -sSL https://cli.formbio.com/public/latest/install/macos | bash
sudo mkdir -p /usr/local/bin/
# Make it available on your $PATH (only need to do this the first time you install)
sudo ln -s $HOME/.local/bin/formbio /usr/local/bin/formbioLinux
# Install via command line
curl -sSL https://cli.formbio.com/public/latest/install/linux | bash
# Make it available on your $PATH (only need to do this the first time you install)
sudo ln -s $HOME/.local/bin/formbio /usr/local/bin/formbioCommands
‣
formbio --help‣
formbio auth --help ‣
formbio storage --help‣
formbio workflow run --helpAuthentication
Login
‣
formbio auth login --helpExample usage:
# logs the user in
formbio auth login‣
# logs the user in when they are already authenticated
formbio auth login‣
Logout
‣
formbio auth logout --helpExample usage:
# logs the user out
formbio auth logout‣
Whoami
‣
formbio auth whoami --helpExample usage:
# list currently authenticated user
formbio auth whoami‣
Data Upload and Download
List
‣
formbio storage ls --helpExample usage:
# list files in top level of project space
formbio storage ls \
formbio://my-organization/my-project/‣
# list files recursively in the "logs" directory
formbio storage ls -r \
formbio://my-organization/my-project/logs/‣
Upload / Download
‣
formbio storage cp --helpExample usage:
# download a single file from the project into mylocaldir
formbio storage cp \
formbio://my-organization/my-project/logs/my_file.txt \
mylocaldir/‣
# upload a single file to the project root
formbio storage cp \
mylocaldir/my_file.txt \
formbio://my-organization/my-project/‣
# upload a local directory to a project subdirectory
formbio storage cp -r \
mylocaldir \
formbio://my-organization/my-project/subdir/‣
# resume a partially completed upload
formbio storage cp -c \
one_gig_file.txt \
formbio://my-organization/my-project/large-files-dir/‣
# downloads files that match the wildcard
# workaround for wildcard support which will come soon:
# formbio storage cp formbio://path/*.txt .
formbio storage ls \
formbio://my-organization/my-project/logs | grep txt |rev| cut -f 1 -d ' ' | rev | awk '{print "formbio storage cp",$1,"."}' |sh‣
Create Directory
# use the -p (--parents) flag to create several nested directories at once
formbio storage mkdir \
-p \
formbio://my-organization/my-project/existing_dir/new_dir/also_new‣
Run Workflows on Form Bio
Launch workflow run
‣
formbio workflow run --helpExample command:
Get workflow run
‣
formbio workflow-run get --helpExample command:
Legal Notices
The formbio CLI tool uses the following Open Source software libraries.
- github.com/gosimple/slug@1.12.0
- https://github.com/hashicorp/errwrap/tree/v1.1.0
- https://github.com/hashicorp/go-multierror/tree/v1.1.1
- github.com/hashicorp/hcl/json/parser@1.0.0
← Previous
Add link here
Next →
Add link here
On this page
- Form Bio CLI/SDK
- Installing and Updating the formbio CLI tool
- Windows
- MacOS
- Linux
- Commands
- Authentication
- Login
- Logout
- Whoami
- Data Upload and Download
- List
- Upload / Download
- Create Directory
- Run Workflows on Form Bio
- Launch workflow run
- Get workflow run
- Legal Notices