Skip to main content

Quickstart

Prerequisites​

  1. Install Go
  2. Install Docker
  3. Install smithyctl via the command line:
go install github.com/smithy-security/smithy/smithyctl@latest

Check where your smithyctl is, e.g. in ~/go/bin/smithyctl. You can find if smithyctl is in your path by running smithyctl version

Run a Workflow​

There are several examples in the /examples folder.

To run one of them (e.g. with Bandit for Python):

smithyctl workflow run \
  --overrides=./examples/bandit/overrides.yaml \
  --build-component-images=true ./examples/bandit/workflow.yaml

You should see the workflow results in your shell. To run a custom workflow, check out the next tutorial.