Get Involved

Turbot Guardrails CLI Commands

Turbot Guardrails CLI supports the following commands:

Command	Description
aws	Manage credentials for AWS profiles
completion	Generate CLI auto-complete script
compose	Compose a mod. Resolve all inclusion directives starting from 'package.source', output to 'package.main.'
configure	Alias for `turbot workspace configure`
download	Download mod zip file from registry
graphql	Execute GraphQL queries and mutations against the Turbot Guardrails API
init	Create a new mod and initialise with common controls
inspect	Display summary information about the mod
install	Download mod header files for all dependencies and install in turbot_mods folder
login	Login to Turbot Guardrails mod registry. Required before running 'publish' or 'install'
pack	Pack the mod into a zipfile
publish	Publish the mod to the Turbot Guardrails mod registry
template	Manage template based resources
test	Run tests for the mod
up	Deploy the mod to a Turbot Guardrails workspace
vcr <command>	Background process to record and mock HTTP requests. Commonly used with 'turbot test'
workspace	Manage Turbot Guardrails workspace credentials for this machine

Global Options