mesheryctl system

Configure, deploy, and operate Meshery deployments

The system command manages the lifecycle and configuration of Meshery server and its components.

Synopsis

mesheryctl system [subcommand] [flags]

Subcommands

• start - Start Meshery and all components
• stop - Stop all Meshery containers or Kubernetes resources
• restart - Restart Meshery
• status - Check status of Meshery components
• reset - Reset Meshery configuration to default
• update - Update Meshery containers or Kubernetes deployments
• logs - View logs from Meshery components
• context - Manage Meshery deployment contexts
• channel - Switch between release channels (stable/edge)
• check - Run preflight checks
• dashboard - Open Meshery UI in browser
• login - Authenticate with Meshery provider
• logout - Logout from current provider
• token - Manage authentication tokens
• provider - Manage and switch between providers
• config - Configure Meshery settings
• delete - Delete Meshery deployment

Global Flags

--context · string

Temporarily change the current context. Short form: -c

--yes · boolean · default: "false"

Assume yes for user interactive prompts. Short form: -y

start

Start Meshery and each of its cloud native components.

Usage

mesheryctl system start [flags]

Flags

--platform · string · default: "docker"

Platform to deploy Meshery. Options: docker, kubernetes. Short form: -p

--skip-update · boolean · default: "false"

Skip checking for new updates available in Meshery

--skip-browser · boolean · default: "false"

Skip opening MesheryUI in browser after start

--reset · boolean · default: "false"

Reset Meshery’s configuration file to default settings

--provider · string

Provider to use for authentication (e.g., “Meshery”, “None”)

Examples

Basic Start

# Start Meshery with default settings
mesheryctl system start

The first time you run mesheryctl system start, it downloads necessary container images which may take a few minutes.

stop

Stop all Meshery containers (Docker) or remove all resources (Kubernetes).

Usage

mesheryctl system stop [flags]

Flags

--reset · boolean · default: "false"

Reset Meshery’s configuration file to default settings

--keep-namespace · boolean · default: "false"

Keep the Meshery namespace during uninstallation (Kubernetes only)

--force · boolean · default: "false"

Force uninstall Meshery resources when normal stop doesn’t work

Examples

# Stop Meshery
mesheryctl system stop

# Stop and reset configuration
mesheryctl system stop --reset

# Stop but keep namespace (Kubernetes)
mesheryctl system stop --keep-namespace

# Force stop when encountering errors
mesheryctl system stop --force

status

Check the status of Meshery and its components.

Usage

mesheryctl system status [flags]

Flags

--verbose · boolean · default: "false"

Display extra data in status table including Pod names and IPs. Short form: -v

Examples

# Check status
mesheryctl system status

# Detailed status with pod information
mesheryctl system status --verbose

Sample Output

Meshery Status:
Name                  Ready   Status    Restarts   Age
meshery-server        1/1     Running   0          2m
meshery-broker        1/1     Running   0          2m
meshery-meshsync      1/1     Running   0          2m

Meshery endpoint is http://localhost:9081

restart

Restart Meshery and its components.

Usage

mesheryctl system restart

Example

# Restart Meshery
mesheryctl system restart

reset

Reset Meshery to default configuration.

Usage

mesheryctl system reset

Example

# Reset Meshery configuration
mesheryctl system reset

This command resets the configuration file but does not remove deployed resources. Use with system stop --reset to completely reset the installation.

update

Update Meshery container images or Kubernetes deployments to the latest version.

Usage

mesheryctl system update [flags]

Example

# Update Meshery
mesheryctl system update

logs

View logs from Meshery components.

Usage

mesheryctl system logs [component-name] [flags]

Flags

--follow · boolean · default: "false"

Follow log output. Short form: -f

Examples

# View all Meshery logs
mesheryctl system logs

# View specific component logs
mesheryctl system logs meshery-server

# Follow logs in real-time
mesheryctl system logs --follow

context

Manage Meshery deployment contexts. Contexts store endpoint, platform, and authentication information.

Usage

mesheryctl system context [subcommand]

Subcommands

• create - Create a new context
• delete - Delete a context
• list - List all contexts
• switch - Switch to a different context
• view - View current context details

Examples

Create Context

# Create local context
mesheryctl system context create local --url http://localhost:9081

# Create and set as current
mesheryctl system context create prod --url https://meshery.example.com --set

channel

Switch between Meshery release channels.

Usage

mesheryctl system channel [stable|edge]

Examples

# Switch to stable channel
mesheryctl system channel stable

# Switch to edge channel for latest features
mesheryctl system channel edge

# View current channel
mesheryctl system channel view

check

Run preflight checks to verify system requirements.

Usage

mesheryctl system check [flags]

Flags

--preflight · boolean · default: "true"

Run preflight checks before operations

Example

# Run system checks
mesheryctl system check

Checks Performed

• Docker/Kubernetes availability
• Network connectivity
• Required ports availability
• Permissions

dashboard

Open Meshery UI in the default browser.

Usage

mesheryctl system dashboard [flags]

Flags

--port · integer · default: "9081"

Port on which Meshery UI is running

--port-forward · boolean · default: "false"

Enable port forwarding (Kubernetes only)

Examples

# Open dashboard
mesheryctl system dashboard

# Open with port forwarding (Kubernetes)
mesheryctl system dashboard --port-forward

login

Authenticate with a Meshery provider.

Usage

mesheryctl system login [flags]

Example

# Login to Meshery
mesheryctl system login

logout

Logout from the current provider.

Usage

mesheryctl system logout

Example

# Logout
mesheryctl system logout

token

Manage authentication tokens.

Usage

mesheryctl system token [subcommand]

Subcommands

• create - Generate a new token
• list - List all tokens
• delete - Delete a token

Examples

# Create new token
mesheryctl system token create mytoken

# List tokens
mesheryctl system token list

# Delete token
mesheryctl system token delete mytoken

provider

Manage and switch between Meshery providers.

Usage

mesheryctl system provider [subcommand]

Subcommands

• list - List available providers
• switch - Switch to a different provider
• set - Set default provider

Examples

# List providers
mesheryctl system provider list

# Switch provider
mesheryctl system provider switch Meshery

delete

Delete Meshery deployment and resources.

Usage

mesheryctl system delete

Example

# Delete Meshery
mesheryctl system delete

This command removes all Meshery resources including configurations. Use system stop if you want to preserve configuration.

Troubleshooting

Meshery Won’t Start

# Check system requirements
mesheryctl system check

# View logs for errors
mesheryctl system logs

# Try force restart
mesheryctl system stop --force
mesheryctl system start

Port Already in Use

If port 9081 is already in use, edit the config file:

# Edit ~/.meshery/config.yaml and change the endpoint port
# Then restart Meshery
mesheryctl system restart

Connection Refused

# Verify Meshery is running
mesheryctl system status

# Check the endpoint in your context
mesheryctl system context view

# Ensure endpoint matches where Meshery is running