Command Reference

Categories and Command Structure

Meshery CLI commands are categorized by function, which are:

• mesheryctl - Global flags and CLI configuration
• mesheryctl system - Meshery Lifecycle and Troubleshooting
• mesheryctl mesh - Service Mesh Lifecycle & Configuration Management: provisioning and configuration best practices
• mesheryctl perf - Service Mesh Performance Management: Workload and service mesh performance characterization
• mesheryctl pattern - Service Mesh Pattern Configuration & Management: Service mesh patterns and Open Application Model integration
• mesheryctl app - Service Mesh Application Management
• mesheryctl filter - Data Plane Intelligence: Registry and configuration of WebAssembly filters for Envoy (experimental feature)

Global Commands and Flags

Command	Subcommand	Flag	Function
mesheryctl			A global command that displays an overview of all commands.
	--config	configures Meshery with the meshconfig, generated with the help of user details to provide cluster access for public clouds(GKE/EKS).
	--help, -h	Displays helpful information about any command.
	--verbose, -v	Sets the log level to debug for verbose output and displays verboose/debug logs.
version		Displays the version of the Meshery Client (mesheryctl) and the SHA of the release binary.
completion		Output shell completion code for the specified shell.

Meshery Lifecycle Management and Troubleshooting

Installation, troubleshooting and debugging of Meshery and its adapters.

Main Command	Arguments	Flag	Function
system			Lifecycle management of Meshery deployments
	--context, -c	Temporarily override your current context by specifying an alternative context as an argument.
start		Start Meshery
--skip-update	(optional) skip checking for new updates available in Meshery.
--reset	Reset Meshery’s configuration file to default settings.
--silent	Silently create Meshery's configuration file with default settings.
stop		Stop Meshery
--reset	Reset Meshery’s configuration file to default settings.
update		Pull new Meshery images from Docker Hub. Does not update mesheryctl. This command may be executed while Meshery is running.
--skip-reset	Pull the latest manifest files
config		Configures Meshery to use a Kubernetes cluster.
--token	Path to token for authenticating to Meshery API.
reset		Resets meshery.yaml file with a copy from Meshery repo
logs		Starts tailing Meshery server debug logs
restart		restart all Meshery containers, their instances and their connected volumes
--skip-update	(optional) skip checking for new updates available in Meshery.
status		Check status of Meshery, Meshery adapters, Meshery Operator and its controllers.
login		Authenticate with the Meshery Provider of your choice: the Local Provider or a Remote Provider.
logout		Invalidate current session with your Meshery Provider.
check		Run system checks for both pre and post mesh deployment scenarios on Meshery
--preflight	Run Pre-mesh deployment checks (Docker and Kubernetes)
--adapter	Run checks on specific mesh adapter
--operator	Verify the health of Meshery Operator's deployment with MeshSync and Broker
--report	Runs diagnostic checks and bundles up to open an issue if present
system-channel			Switch between release channels.
set		Subscribe to release channel and version.
switch		switch 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
--adapters	create a new context in config.yaml file- specify the list of adapters to be added
--set, -s	create a new context in config.yaml file- set as current context
--url, -u	create a new context in config.yaml file- set Meshery server URL. Defaults to "https://localhost:9081"
delete		delete an existing context from Meshery config file
view		view the configurations of the current context
--context	view the configurations of the specified context
--all	if set, shows the configurations of all the contexts
switch		configure mesheryctl to actively use one one context vs. the another context

Service Mesh Performance Management

Main Command	Arguments	Flag	Function
perf			Performance Management and Benchmarking using Meshery CLI
	--output-format, -o	format to display in json or yaml.
	--token	(required) Path to Meshery user's access token.
apply		Runs Performance test using existing profiles or using flags.
--concurrent-requests	Number of Parallel Requests (default: 1).
--duration	Length of the test.
--file	Path to service mesh performance test configuration file (default: empty string).
--load-generator	Choice of load generator - fortio (OR) wrk2 (default: fortio).
--mesh	Name of the service mesh.
--name	A memorable name for the test (default: random string).
--qps	Queries per second (default: 0) (0 - means to use the CPU unbounded to generate as many requests as possible).
--url	(required/optional) URL of the endpoint send load to during testing.
profile		List the available performance profiles.
--page	(optional) List next set of performance profiles with --page (default = 1) (default 1).
--view	(optional) View more information of the performance profile.
result		View the results of a performance profile.
--page	(optional) List next set of performance results with --page (default = 1) (default 1).
--view	(optional) View more information of the performance test results.

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
--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
--spec, -s	(required) specification to be used for conformance test. Defaults to "smi"
--tokenpath, -t	(required) path to token for authenticating to Meshery API
deploy		Deploy a service mesh into the cluster
--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
pattern
	--file, -f	(required) path to pattern file.
list		displays a list of available pattern files
	--all, -a	show all pattern file metadata
apply		apply pattern file will trigger deploy of the pattern file
	--file, -f	apply pattern file will trigger deploy of the pattern file and also supports file retrieval from GitHub
view		displays the contents of a specific pattern file
	--all, -a	show all pattern file content
	-o json	display the content of a pattern in json format
delete		Deprovision the resources/ service mesh using the pattern file
	--file, -f	Deletes the resources that were created, using pattern file

Service Mesh Application Management

Main Command	Command	Flag	Function
app			Service Mesh application management
	--file, -f	(required) path to pattern file
onboard		onboard application
	--file, -f	onboard application with application file
offboard		offboard application
	--file, -f	Offboard application with an application file
list		displays a list of available applications
view		displays the contents of a application
	--all, -a	show all application file content
	-o json	display the content of an application in json format

Data Plane Intelligence (experimental feature)

Main Command	Command	Flag	Function
filter			Service Mesh Filter Management (experimental feature)
	--file, -f	(required) path to WASM file [GitHub links only supported]
apply		Apply WASM file to deploy a filter
delete		Delete filter from Meshery
list		List all WASM filters
view		View the specified WASM filter