Install a Mod using Guardrails CLI

In this guide, you will:

• Install a mod in a Guardrails workspace using the CLI.
• Validate successful installation using the Guardrails UI.

Guardrails supports installing Mods via Guardrails CLI for various scenarios where command-line installation is preferred or required, including Government Cloud environments (e.g., AWS GovCloud) where UI-based interactions may be limited, automated deployment workflows and CI/CD pipelines, scripted installation processes for consistent deployments or restricted environments where direct web access is limited, and bulk mod installations across multiple workspaces.

Important

This CLI-based approach is particularly important for AWS GovCloud environments, where direct access to Turbot's mod registry is restricted because the registry is hosted in commercial AWS accounts.

Prerequisites

• Turbot CLI installed and configured with appropriate credentials
• Valid Turbot/Owner permissions in the target Guardrails workspace
• Mod registry access: Registration at guardrails.turbot.com with approved mod download permissions
• Network access to download mods from guardrails.turbot.com
• One of the following access methods:
  • Access to a bastion host in your GovCloud environment, or
  • Direct network access from your local environment to the hosted workspace

Note

Mod Download Permissions: Even with a guardrails.turbot.com account, you may not have permissions to download mods. If you encounter permission errors during mod download, contact Turbot Support to request access to allow to download mods.

Step 1: Access Your Environment

Note

If a bastion host is not available in your environment, you can create one using this guide: Turbot Bastion Host

For GovCloud Environments

Log into the AWS account associated with your GovCloud production environment and connect to the main bastion host.

For Commercial Cloud Environments

Ensure you have CLI access to your target environment with the Turbot CLI properly configured.

Step 2: Download Mod

Navigate to your desired directory for downloading the mod package, for example: cd /turbot/mods

Download the desired mod package using this Guardrails CLI command. This fetches the specified mod from the Guardrails registry, e.g., @turbot/aws-iam.

turbot download @turbot/aws-iam

Step 3: Install Mod to Workspace

Upload and install the downloaded mod into your target workspace by executing the command below with the appropriate CLI profile.

turbot up --zip-file turbot_aws-iam --profile <profile-name>

Step 4: Review

• Verify successful installation by checking the Guardrails UI after approximately 20 minutes. Ensure the mod appears under Admin > Mods, the version matches the one uploaded (e.g., 5.43.x), and the mod status displays a green checkmark.

Next Steps

Please see the following resources to learn more about Turbot Guardrails Enterprise:

• Learn more about Turbot Guardrails Enterprise - Architecture.
• Learn about Updating Mod.

Troubleshooting