meshstack-cli

meshStack CLI

meshstack is the command line interface for your meshStack instance, handling multiple meshStacks via the meshstack profile command.

Start with meshstack login --profile your-profile-name and explore the CLI with meshstack --help, after you install it.

The meshStack Terraform provider builds on this login as follows:

provider "meshstack" {
  profile   = "your-profile-name" # login creates 'default' initially
  workspace = "your-workspace"    # 'meshstack workspace list' finds one,
                                  # or leave it to the profile's default workspace
}

Commands meant for people, such as meshstack auth status and meshstack profile list, write Markdown. The other commands write JSON, or one item per line with --output ndjson, for scripts and agentic AI workflows that read it through a | jq ... pipe. A listing stops at 100 items unless --limit says otherwise.

On a terminal, the Markdown is rendered and the log is colored. NO_COLOR turns the colors off, and FORCE_COLOR or CLICOLOR_FORCE turns them on where the output is no terminal, such as in a CI job. GitHub Actions, GitLab CI and Azure Pipelines get a colored log without being asked, and the log of a building block run stays plain, since meshPanel shows it as plain text.

meshstack api sends an authenticated, curl-like request to any path of the API. For a meshObject endpoint it picks the latest version the OpenAPI docs list, and meshstack api-docs shows what those docs say about a request.

Install

With Homebrew

brew install meshcloud/tap/meshstack-cli
brew upgrade meshstack-cli

With winget on Windows

winget install meshcloud.meshstack-cli
winget upgrade meshcloud.meshstack-cli

With Go

go install github.com/meshcloud/meshstack-cli/cmd/meshstack@latest

...or without installing it:

go run github.com/meshcloud/meshstack-cli/cmd/meshstack@latest --version

With Nix (flakes enabled)

nix profile add github:meshcloud/meshstack-cli   # older Nix: `nix profile install`
nix profile upgrade meshstack-cli

...or without installing it:

nix run github:meshcloud/meshstack-cli -- --version

⚠ nix profile upgrade follows the main branch, not releases.

With the install script

curl -fsSL https://raw.githubusercontent.com/meshcloud/meshstack-cli/main/install.sh | sh

Run it again to upgrade. | sh -s -- --version v1.2.3 --dir ~/bin pins a release and the directory, and | sh -s -- --help lists the options.

On Windows, in PowerShell:

irm https://raw.githubusercontent.com/meshcloud/meshstack-cli/main/install.ps1 | iex

It installs with winget when winget is available, and otherwise downloads the release into %LOCALAPPDATA%\Programs\meshstack-cli and adds that directory to your user PATH. Run it again to upgrade. To pass options, run it as a script block:

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/meshcloud/meshstack-cli/main/install.ps1))) -Version v1.2.3 -Dir ~\bin

-NoWinget downloads the release even when winget is available, and -Help lists the options.

Development

This repository also holds the Go client for the meshStack API in client/, which the meshStack Terraform provider imports.

The Nix dev shell provides Go, goreleaser and task:

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