Quick Start
Getting Meshery up and running on a locally on Docker-enabled system is easy. Use the Meshery command line interface, mesheryctl
, to start Meshery on any of its supported platforms.
Using mesheryctl
mesheryctl
is a command line interface to manage a Meshery deployment. mesheryctl
allows you to control Meshery’s lifecycle with commands like start
, stop
, status
, reset
. Running reset
will remove all active container instances, prune pulled images and remove any local volumes created by starting Meshery.
Mac or Linux
Use your choice of homebrew or bash to install mesheryctl
. You only need to use one.
Homebrew
Install mesheryctl
and run Meshery on Mac with Homebrew.
Installing with Homebrew
To install mesheryctl
, execute the following commands:
brew tap layer5io/tap
brew install mesheryctl
mesheryctl system start
Upgrading with Homebrew
To upgrade mesheryctl
, execute the following command:
brew upgrade mesheryctl
Example output of a successful upgrade:
➜ ~ brew upgrade mesheryctl
==> Upgrading 1 outdated package:
layer5io/tap/mesheryctl 0.3.2 -> 0.3.4
==> Upgrading layer5io/tap/mesheryctl
==> Downloading https://github.com/layer5io/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
Installing with Bash
Install mesheryctl
and run Meshery on Mac or Linux with this script:
curl -L https://meshery.io/install | bash -
Upgrading with Bash
Upgrade mesheryctl
and run Meshery on Mac or Linux with this script:
curl -L https://meshery.io/install | bash -
Windows
Installing the mesheryctl
binary
Download and unzip mesheryctl
from the Meshery releases page. Add mesheryctl
to your PATH for ease of use. Then, execute:
./mesheryctl system start
Scoop
Use Scoop to install Meshery on your Windows machine.
Installing with Scoop
Add the Meshery Scoop Bucket and install:
scoop bucket add mesheryctl https://github.com/layer5io/scoop-bucket.git
scoop install mesheryctl
Upgrading with Scoop
To upgrade mesheryctl
, execute the following command:
scoop update mesheryctl
Upon starting Meshery successfully, instructions to access Meshery will be printed on the sceen.