README
¶
Signadot CLI
This is the source repository for the Signadot command-line interface.
Please see the usage guide if all you want is to install and run the CLI.
To file an issue, please use our community issue tracker.
NOTE: Starting next release, and hence in the main branch, this repository has a dependency on a private repository, and hence building or running from source will not work. Previous releases should continue to work.
Build
To build the CLI from source, such as to test changes, you'll need Go 1.18+.
The main package is in cmd/signadot:
go build ./cmd/signadot
Release
To release the CLI, you'll need GoReleaser as well as a GiHtub token with write permissions to Signadot's repos.
Check out the desired commit and then push a new tag:
git tag -a -m 'Release vX.Y.Z' vX.Y.Z
git push origin vX.Y.Z
Then run GoReleaser, which will build and push all release artifacts:
GITHUB_TOKEN=... make release
See Also
The CLI is built on top of the Go SDK.
The CLI is built using libconnect.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
clio
Package clio abstracts common command-line I/O patterns.
|
Package clio abstracts common command-line I/O patterns. |
|
config
Package config defines all the variables that users can set (through flags, environment vars, or the config file) to affect command behavior.
|
Package config defines all the variables that users can set (through flags, environment vars, or the config file) to affect command behavior. |
|
poll
Package poll is an opinionated library for polling in the Signadot CLI.
|
Package poll is an opinionated library for polling in the Signadot CLI. |
|
spinner
Package spinner displays a progress indicator with a live-updating status message.
|
Package spinner displays a progress indicator with a live-updating status message. |