chrs 0.0.4

CLI ChRIS client
chrs-0.0.4 is not a library.

chrs

crates.io version Publish

chrs is a command-line client for ChRIS. It can upload files to ChRIS library, download files from ChRIS, and can run and feeds (computational experiments) on ChRIS.

Installation

There are two ways to install chrs.

Download

Pre-compiled binaries are automatically built and uploaded to Github Releases. Get the latest version here:

https://github.com/FNNDSC/chrs/releases/latest

This is the easiest installation method, however there is no mechanism for automatic updates.

Get from Crates.io

Use cargo to get and build the package from crates.io:

cargo install chrs

If necessary, add the bin folder to $PATH:

echo 'export PATH=$HOME/.cargo/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Using chrs

Run chrs --help for usage information.

Note: when specifying URLs, they should be to the backend API, not the front-end. E.g. instead of https://app.chrisproject.org/feeds/1520, the correct URL would be https://cube.chrisproject.org/api/v1/1520/.

Overview

chrs --address https://cube.chrisproject.org/api/v1/ --username chris --password chris1234 login
chrs upload my_data/

chrs login

chrs login saves authentication tokens securely using your keyring. Logging into multiple different instances of ChRIS is supported, or as different users on the same ChRIS instance.

# log in, type username and password interactively
chrs --address https://cube.chrisproject.org/api/v1/ login

# log in without using keyring and non-interactively, useful for automation
chrs --address https://cube.chrisproject.org/api/v1/ --username test-user login --no-keyring --password-stdin <<< "$PASSWORD"

chrs logout

Remove previously saved authentication token(s).

# remove saved logins for cube.chrisproject.org
chrs --address https://cube.chrisproject.org/api/v1/ logout

# remove all saved logins
chrs logout

chrs pipeline-file add

Uploads a file-representation of a ChRIS pipeline. The file should be a JSON file. (plugin_tree may be either a string (canonical) or an object). YAML support coming soon.

chrs pipeline-file add chris/tests/data/pipelines/fetal_brain_reconstruction_expanded.json