Skip to main content
mesheryctl is the command-line interface for Meshery, enabling you to manage cloud native infrastructure, designs, performance tests, and lifecycle operations from your terminal.

​
Installation

See Installation Guide for platform-specific installation instructions.

​
Global Flags

These flags are available for all mesheryctl commands:
​
--config
string
default:"~/.meshery/config.yaml"
Path to the Meshery configuration file
​
--verbose
boolean
default:"false"
Enable verbose output for debugging. Short form: -v
​
--help
boolean
Display help information for any command. Short form: -h

​
Command Categories

​
Lifecycle Management

  • system - Deploy, configure, and manage Meshery server and components

​
Design Management

  • design - Create, apply, and manage cloud native infrastructure designs
  • model - Work with infrastructure models in the registry
  • component - Manage Meshery components
  • relationship - Define and manage component relationships

​
Performance Testing

  • perf - Run performance tests and manage test profiles

​
Workspaces & Environments

​
Registry Management

  • registry - Manage the Meshery capability registry

​
Usage Examples

# Display help
mesheryctl --help

# Show version
mesheryctl version

# Enable verbose logging
mesheryctl --verbose system status

​
Configuration File

The default configuration file is located at ~/.meshery/config.yaml. This file stores:
  • Current context and platform settings
  • Meshery server endpoint
  • Authentication tokens
  • Component versions and channels
You can specify a different config file using the --config flag on any command.

​
Command Completion

Generate shell completion scripts: 
# Bash
mesheryctl completion bash > /etc/bash_completion.d/mesheryctl

# Zsh
mesheryctl completion zsh > "${fpath[1]}/_mesheryctl"

# Fish
mesheryctl completion fish > ~/.config/fish/completions/mesheryctl.fish

# PowerShell
mesheryctl completion powershell > mesheryctl.ps1

​
Getting Help

Every command and subcommand supports the --help flag: 
mesheryctl --help
mesheryctl system --help
mesheryctl system start --help

​
Exit Codes

  • 0 - Success
  • 1 - General error
  • 2 - Misuse of command (invalid flags or arguments)

​
See Also