README
¶
Smithyctl
Smithyctl is the CLI used to develop new components, run them in workflows and distributing them.
Installation
Precompiled Binaries
Visit the releases and pick the binary for your OS/Architecture.
From source
You must have go installed, and then run:
go install github.com/smithy-security/smithy/smithyctl@latest
Verify installation
Run:
smithyctl version
Flags
| Flag | Description | Default |
|---|---|---|
debug-enabled |
enabled debug logs. | false |
debug-level |
sets the log level. Possible values debug, info, warning and error. |
debug |
Commands
| Command | Description |
|---|---|
help |
will output how to use smithyctl |
version |
will output the version of the installed smithyctl binary |
component |
allows to develop, run and distribute components |
workflow |
allows to develop and run workflows |
Component
- packaging: distributes a component specified in a component.yaml
- build: allows to build component images.
Workflow
- run: runs components specified in a workflow.yaml
Development
Compile smithyctl locally by running make smithyctl/bin in the root of this project.
You can then find the binary in ./bin/smithyctl/cmd/{GOOS}/{GOARCH}/smithyctl.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.