Skip to content

REDCap ♥ VisiData in this command-line tool for quick, ad-hoc interaction with REDCap's web API

Notifications You must be signed in to change notification settings

tsibley/redcap-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 

Repository files navigation

usage: redcap <command> [arguments…]
       redcap project                 Fetch project metadata
       redcap fields                  Fetch field descriptions and metadata
       redcap records                 Fetch all records
       redcap record <id> [id […]]    Fetch the given record(s)
       redcap api <key>=<value> […]   Make a raw API request
       redcap help                    Show this help

Quick, ad-hoc interaction with REDCap's web API for easier development and
exploration.

If stdout is to a terminal and the `vd` (https://visidata.org) command is
available, output will automatically be displayed in it.

The API endpoint and authentication token must be provided via the
environment variables REDCAP_API_URL and REDCAP_API_TOKEN.

Besides any normal arguments they take, all commands also accept raw REDCap
API parameters as "key=value" arguments.  For example, normally running:

    redcap record 42

would return data from all instruments/forms for record #42.  You can limit
to specific instruments of interest using:

    redcap record 42 forms=some_instrument_name

About

REDCap ♥ VisiData in this command-line tool for quick, ad-hoc interaction with REDCap's web API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages