mesheryctl Command Reference

Categories and Command Structure

Meshery CLI commands are categorized by function, which are:

  • mesheryctl - Global flags
  • mesheryctl system - Meshery Lifecycle and Troubleshooting
  • mesheryctl mesh - Service Mesh Lifecycle & Configuration Management
  • mesheryctl perf - Service Mesh Performance Management
  • mesheryctl pattern - Service Mesh Pattern Configuration & Management

Global Commands and Flags

Command Subcommand Flag Function
mesheryctl Displays help about any command.
version Displays the version of the Meshery Client (mesheryctl) and the SHA of the release binary.
--help, -h Displays helpful information about any command.
--verbose, -v Sets the log level to debug for verbose output and displays verboose/debug logs.
--config configures Meshery with the kubeconfig, generated with the help of user details, to provide cluster access for public clouds(GKE/EKS).

Meshery Lifecycle Management and Troubleshooting

Installation, troubleshooting and debugging of Meshery and its adapters.

Main Command Arguments Flag Function
--context, -c Temporarily change the current context.
start Start Meshery.
--skip-update (optional) skip checking for new updates available in Meshery.
--silent Silently create Meshery's configuration file with default settings.
--reset Reset Meshery’s configuration file to default settings.
stop Stop all Meshery containers.
--reset Reset Meshery’s configuration file to default settings.
reset Resets meshery.yaml with copy from Meshery repo. Warning - Any local changes will be overwritten.
completion Generates completion script.
log Starts tailing Meshery server debug logs.
status Displays the status of Meshery’s containers (server and adapters).
update Pull new Meshery images from Docker Hub. Does not pulls new mesheryctl client. This command may be executed while Meshery is running.
restart Restart all Meshery containers, their instances and their connected volumes.
config Configures Meshery to use a Kubernetes cluster.
system channel Switch between release channels.
--switch switch release channel and version
--set set release channel and version.
view view release channel and version
--all, -a view release channel and version
system context Display the current context.
create create a new context in config.yaml file
--url, -u create a new context in config.yaml file- set Meshery server URL. Defaults to "https://localhost:9081"
--set, -s create a new context in config.yaml file- set as current context
--adapters create a new context in config.yaml file- specify the list of adapters to be added
switch switch between contexts
delete delete the specified context from the config.yaml file
view view the configurations of the current context
--all if set, shows the configurations of all the contexts
--context view the configurations of the specified context

Service Mesh Performance Management

Main Command Flag Function
perf Performance management - baselining and testing.
--duration Duration of the test.
--mesh Name of the service mesh. (default) empty string
--concurrent-requests Number of concurrent requests (default) 1
--qps Queries per second (default) 0 (0 - means to use the CPU unbounded to generate as many requests as possible.
--url (required) URL of the endpoint send load to during testing.
--profile Performance profile to use for running tests
--token Path to Meshery auth token
--file URL of the service mesh performance test configuration file. (default) empty string.
--load-generator Choice of load generator - fortio (OR) wrk2 (default) fortio
--name A memorable name for the test. (default) a random string

Service Mesh Lifecycle and Configuration Management

Main Command Command Flag Function
mesh Lifecycle management of service meshes
validate validate service mesh conformance to different standard specifications
--spec, -s (required) specification to be used for conformance test. Defaults to "smi"
--adapter, -a (required) adapter to use for validation. Defaults to "meshery-osm:10010"
--namespace, -n Kubernetes namespace to be used for deploying the validation tests and sample workload
--tokenpath, -t (required) path to token for authenticating to Meshery API

Service Mesh Pattern Configuration and Management

Main Command Command Flag Function
--file, -f (required) path to pattern file.
apply apply pattern file
delete delete pattern file
list displays a list of available pattern files
--all, -a show all pattern file metadata
view displays the contents of a specific pattern file
-o json display the content of a pattern in json format
--all, -a show all pattern file content