Once homebrew is installed, run the following:
brew tap thedannywahl/inst-api
brew install inst-api
Download or clone the latest release and symlink the scripts to a location supported in your $PATH
The included scripts require the following dependencies. The scripts will attempt to install brew
dependencies if they're not found. System or built-in commands must be installed by the user.
All commands store credentials in a dot file in the user home directory, specifically ~/.inst
and they source the contents at runtime. DO NOT store your tokens or credentials on a shared machine or user space. If security is a concern, all commands allow you to pass credentials in via options at runtime using -t <token>
, -p <password>
, or the like. Check the help documentation for the each command for specific details. This allows you to use other credential managers like vaulted. See help (-h
) for more information with each command.
All curl
commands use --tlsv1.2
, downgrading is not supported in the utilities (or generally in the servers). All paths explicitly start with https
. Instructure products WILL NOT function over http
except to redirect to https
.