Install mesheryctl
Mesheryβs command line client is mesheryctl
and is the recommended tool for configuring and deploying one or more Meshery deployments. To install mesheryctl
on your system, you may choose from any of the following supported methods.
mesheryctl
can be installed via bash, Homebrew, Scoop or directly downloaded.
Install Meshery CLI with Brew
Prerequisites
You need to have Brew
installed on your Linux or macOS system to perform these actions.
Install mesheryctl
using Brew
To install mesheryctl
using homebrew, execute the following commands.
$ brew install mesheryctl
Youβre ready to run Meshery. To do so, execute the following command.
$ mesheryctl system start
Meshery server supports customizing authentication flow callback URL, which can be configured in the following way
$ MESHERY_SERVER_CALLBACK_URL=https://custom-host mesheryctl system start
mesheryctl
uses your current Kubernetes context, your KUBECONFIG environment variable (~/.kube/config
by default). Confirm if this Kubernetes cluster you want Meshery to interact with by running the following command: kubectl config get-contexts
.
If there are multiple contexts in your kubeconfig file, specify the one you want to use with the use-context
subcommand: kubectl config use-context <context-to-use>
.
Upgrade mesheryctl
using Brew
To upgrade mesheryctl
, execute the following command.
$ brew upgrade mesheryctl
Example output of a successful upgrade.
β ~ brew upgrade mesheryctl
==> Upgrading 1 outdated package:
meshery/tap/mesheryctl 0.3.2 -> 0.3.4
==> Upgrading meshery/tap/mesheryctl
==> Downloading https://github.com/meshery/meshery/releases/download/v0.3.4/mesheryctl_0.3.4_Darwin_x86_64.zip
==> Downloading from https://github-production-release-asset-2e65be.s3.amazonaws.com/157554479/17522b00-2af0-11ea-8aef-cbfe8
######################################################################## 100.0%
πΊ /usr/local/Cellar/mesheryctl/0.3.4: 5 files, 10.2MB, built in 4 seconds
Removing: /usr/local/Cellar/mesheryctl/0.3.2... (5 files, 10.2MB)
Removing: /Users/lee/Library/Caches/Homebrew/mesheryctl--0.3.2.zip... (3.9MB)
==> Checking for dependents of upgraded formulae...
==> No dependents found!
Install Meshery CLI with Bash
To install or upgrade mesheryctl
using bash
, execute anyone of the following commands.
Option 1: Only install mesheryctl
binary
$ curl -L https://meshery.io/install | DEPLOY_MESHERY=false bash -
Option 2: Install mesheryctl
binary and deploy Meshery on Docker
$ curl -L https://meshery.io/install | PLATFORM=docker bash -
Option 3: Install mesheryctl
binary and deploy Meshery on Kubernetes
$ curl -L https://meshery.io/install | PLATFORM=kubernetes bash -
Option 4: Install mesheryctl
binary and Meshery adapter(s)
Install mesheryctl
binary and include one or more adapters to be deployed
$ curl -L https://meshery.io/install | ADAPTERS=consul PLATFORM=kubernetes bash -
Start Meshery
You are ready to deploy Meshery mesheryctl
. To do so, execute the following command.
mesheryctl system start
Install Meshery CLI with Scoop
Prerequisites
You need to have scoop
installed on your Windows system to perform these actions.
Install mesheryctl
with Scoop
To install mesheryctl
using Scoop, execute the following commands.
scoop bucket add mesheryctl https://github.com/meshery/scoop-bucket.git scoop install mesheryctl
Youβre ready to run Meshery. To do so, execute the following command.
mesheryctl system start
Upgrade mesheryctl
with Scoop
To upgrade mesheryctl
, execute the following command.
scoop update mesheryctl
Continue deploying Meshery onto one of the Supported Platforms.
Related Reading
Meshery CLI Guides
Guides to using Mesheryβs various features and components.
- Authenticating with Meshery via CLI
- Configuring Autocompletion for `mesheryctl`
- Running system checks using Meshery CLI
- Mesheryctl system commands
- Using Meshery CLI
- Upgrading Meshery CLI
Recent Discussions with "mesheryctl" Tag
- Oct 31 | `pattern import` - Access to this resource is unauthorized
- Oct 24 | `mesheryctl adapter validate` "Error: required flag(s) "spec" not set"
- Oct 09 | I created an environment but it cannot be listed
- Mar 05 | Tip: Series of commands to generate Meshery's model registry
- Aug 28 | Problems when running `./mesheryctl system start -p docker`
- Aug 19 | Adapter unavailable when open Meshery playground on local host via Mesheryctl
- Aug 09 | Help needed to setup Meshery locally
- Jun 27 | [Open Discussion] Consistency and Test Cases for Mesheryctl (Meshery CLI)
- May 30 | Looking for a meshmate to help with first PR
- Mar 20 | Not able to access Ports during mesheryctl system start