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

If you are running Meshery on Docker, execute the following command.

 $ mesheryctl system start -p docker

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
 
 

➜  ~ 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 -
 
 

 

 

  $ curl -L https://meshery.io/install | PLATFORM=docker bash -
 
 

 

 

  $ curl -L https://meshery.io/install | PLATFORM=kubernetes bash -
 
 

Install mesheryctl binary and include one or more adapters to be deployed

 

 

  $ curl -L https://meshery.io/install | ADAPTERS=consul PLATFORM=kubernetes bash -
 
 

 
mesheryctl system start
 

If you are running Meshery on Docker, execute the following command.

 
mesheryctl system start -p docker
 

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

If you are running Meshery on Docker, execute the following command.

mesheryctl system start -p docker

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 Meshery via CLI
• Configuring Autocompletion for `mesheryctl`
• Mesheryctl system commands
• Running system checks using Meshery CLI
• Using Meshery CLI
• Upgrading Meshery CLI