Overview

To set up and run Meshery on Linux or macOS, you will need to install mesheryctl. mesheryctl is the command line interface (CLI) for Meshery. It is used to install, manage, and operate one or more Meshery deployments. mesheryctl can be installed via bash is also available directly or through Homebrew or Scoop.

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!

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

Meshery CLI Guides

Guides to using Meshery’s various features and components.

Recent Discussions with "mesheryctl" Tag

Dec 16 | Can't find the file path for meshery designs by Pranjal Gupta
Oct 31 | `pattern import` - Access to this resource is unauthorized by Lawrence Li
Oct 24 | `mesheryctl adapter validate` "Error: required flag(s) "spec" not set" by Lawrence Li
Oct 09 | I created an environment but it cannot be listed by Pranjal Gupta
Mar 05 | Tip: Series of commands to generate Meshery's model registry by Lee Calcote
Aug 28 | Problems when running `./mesheryctl system start -p docker` by Kunyue Xing
Aug 19 | Adapter unavailable when open Meshery playground on local host via Mesheryctl by Kunyue Xing
Aug 09 | Help needed to setup Meshery locally by Hritesh Goldar
Jun 27 | [Open Discussion] Consistency and Test Cases for Mesheryctl (Meshery CLI) by Shlok Mishra
May 30 | Looking for a meshmate to help with first PR by Faisal Imtiyaz123

Overview

Brew

Prerequisites

Install mesheryctl using Brew

Upgrade mesheryctl using Brew

Bash

Option 1: Only install mesheryctl binary

Option 2: Install mesheryctl binary and deploy Meshery on Docker

Option 3: Install mesheryctl binary and deploy Meshery on Kubernetes

Option 4: Install mesheryctl binary and Meshery adapter(s)