README
¶
meshStack CLI
meshstack is the command line interface for meshStack. This
repository also holds the Go client for the meshStack API, which the
meshStack Terraform provider imports.
Install
With Homebrew, on macOS or Linux:
brew install meshcloud/tap/meshstack-cli
brew upgrade meshstack-cli
With Go:
go install github.com/meshcloud/meshstack-cli/cmd/meshstack@latest
With Nix (flakes enabled), on Linux (x86_64, aarch64) or on an Apple Silicon Mac:
nix profile add github:meshcloud/meshstack-cli # older Nix versions call this `nix profile install`
nix profile upgrade meshstack-cli
nix profile upgrade follows the main branch, not releases. To try it without installing it,
run nix run github:meshcloud/meshstack-cli -- --version.
Development
The Nix dev shell provides Go, goreleaser and task. task lint builds golangci-lint from
the tool directive in go.mod, so the dev shell deliberately does not carry it:
nix develop
task build # writes ./meshstack
task test
task lint # add -- --fix to apply the fixes it can make itself
task release:snapshot # the release artifacts, into dist/, without publishing them
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
meshstack
command
Command meshstack is the command line interface (CLI) for meshStack.
|
Command meshstack is the command line interface (CLI) for meshStack. |
|
internal
|
|
|
testutil/jsontest
Package jsontest holds the json helpers that only a test needs.
|
Package jsontest holds the json helpers that only a test needs. |
|
testutil/testserver
Package testserver stands in for meshStack's login endpoint and for one endpoint behind it, so that a test can drive the token cache without a backend.
|
Package testserver stands in for meshStack's login endpoint and for one endpoint behind it, so that a test can drive the token cache without a backend. |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.