otty / apps

All apps/Meshery CLI

Meshery CLI

mesheryctl

Runs as mesheryctl|macOS, Linux, Windows|docs.meshery.io

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

Meshery CLI in your home directory Every rule on this page, by file

contexts.*.token

Lifted into your secret store; the rest of the file syncs.

· meshery.yaml Sync

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/mesheryctl/otty.tomlThe file this page is generated from

id = "mesheryctl"

name = "Meshery CLI"

homepage = "https://docs.meshery.io/guides/mesheryctl/working-with-mesheryctl/"

executables = ["mesheryctl"]

[dotfiles]

# Meshery's official CLI guide documents ~/.meshery/config.yaml as the default

# meshconfig and ~/.meshery/meshery.yaml for advanced installation settings.

# The config's contexts carry deployment tokens, so token leaves are treated as

# secrets even though the rest of the YAML is useful configuration.

# https://docs.meshery.io/guides/mesheryctl/working-with-mesheryctl/

paths = ["~/.meshery/config.yaml", "~/.meshery/meshery.yaml"]

secret = []

[[dotfiles.secret_paths]]

file = "~/.meshery/config.yaml"

format = "yaml"

match = { key_path = ["contexts.*.token"] }

[commands]

format = 1

label = "Meshery CLI"

description = "Start, stop and check a Meshery deployment. Other mesheryctl commands (designs, models, contexts, ...) are left out."

quality = "ai-draft"

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]

path = ["system", "start"]

label = "Start Meshery"

[[commands.subcommand.source]]

id = "doc"

kind = "manual"

url = "https://docs.meshery.io/reference/mesheryctl/system/start"

evidence = """

mesheryctl system start [flags]

-p, --platform string platform to deploy Meshery to.

--provider string (optional) Defaults to the provider specified in the current context

--reset (optional) reset Meshery's configuration file to default settings.

--skip-browser (optional) skip opening of MesheryUI in browser.

--skip-update (optional) skip checking for new Meshery's container images.

-c, --context string (optional) temporarily change the current context.

-y, --yes (optional) assume yes for user interactive prompts.

"""

[[commands.subcommand.field]]

id = "platform"

label = "Platform"

type = "string"

option = ["--platform", "-p"]

suggestions = [{ value = "docker", label = "Docker" }, { value = "kubernetes", label = "Kubernetes" }]

sources = ["doc"]

[[commands.subcommand.field]]

id = "provider"

label = "Provider"

type = "string"

option = ["--provider"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "skip_browser"

label = "Do not open the UI"

type = "boolean"

option = ["--skip-browser"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "skip_update"

label = "Skip image update check"

type = "boolean"

option = ["--skip-update"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "reset"

label = "Reset configuration file to defaults"

type = "boolean"

option = ["--reset"]

effect = "overwrite"

sources = ["doc"]

[[commands.subcommand.field]]

id = "context"

label = "Context"

type = "string"

option = ["--context", "-c"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "yes"

label = "Assume yes for prompts"

type = "boolean"

option = ["--yes", "-y"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "start"

label = "Start Meshery"

fields = ["platform", "skip_browser"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["platform", "provider", "skip_browser", "skip_update"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["reset", "context", "yes"]

[[commands.subcommand]]

path = ["system", "stop"]

label = "Stop Meshery"

[[commands.subcommand.source]]

id = "doc"

kind = "manual"

url = "https://docs.meshery.io/reference/mesheryctl/system/stop"

evidence = """

mesheryctl system stop [flags]

--force (optional) uninstall Meshery resources forcefully

--keep-namespace (optional) keep the Meshery namespace during uninstallation

--reset (optional) reset Meshery's configuration file to default settings.

-c, --context string (optional) temporarily change the current context.

-y, --yes (optional) assume yes for user interactive prompts.

"""

[[commands.subcommand.field]]

id = "force"

label = "Force uninstall of resources"

type = "boolean"

option = ["--force"]

effect = "delete"

sources = ["doc"]

[[commands.subcommand.field]]

id = "keep_namespace"

label = "Keep the Meshery namespace"

type = "boolean"

option = ["--keep-namespace"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "reset"

label = "Reset configuration file to defaults"

type = "boolean"

option = ["--reset"]

effect = "overwrite"

sources = ["doc"]

[[commands.subcommand.field]]

id = "context"

label = "Context"

type = "string"

option = ["--context", "-c"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "yes"

label = "Assume yes for prompts"

type = "boolean"

option = ["--yes", "-y"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "stop"

label = "Stop Meshery"

fields = ["keep_namespace"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["keep_namespace", "force"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["reset", "context", "yes"]

[[commands.subcommand]]

path = ["system", "check"]

label = "Check system"

[[commands.subcommand.source]]

id = "doc"

kind = "manual"

url = "https://docs.meshery.io/reference/mesheryctl/system/check"

evidence = """

mesheryctl system check [flags]

--adapter string Check status of specified meshery adapter

--adapters Check status of meshery adapters

--components Check status of Meshery components

--operator Verify the health of Meshery Operator's deployment with MeshSync and Broker

--preflight Verify environment readiness to deploy Meshery

-c, --context string (optional) temporarily change the current context.

-y, --yes (optional) assume yes for user interactive prompts.

"""

[[commands.subcommand.field]]

id = "adapter"

label = "Adapter"

type = "string"

option = ["--adapter"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "adapters"

label = "Check adapters"

type = "boolean"

option = ["--adapters"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "components"

label = "Check components"

type = "boolean"

option = ["--components"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "operator"

label = "Check Meshery Operator"

type = "boolean"

option = ["--operator"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "preflight"

label = "Preflight (environment readiness)"

type = "boolean"

option = ["--preflight"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "context"

label = "Context"

type = "string"

option = ["--context", "-c"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "yes"

label = "Assume yes for prompts"

type = "boolean"

option = ["--yes", "-y"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "preflight"

label = "Preflight check"

fields = ["preflight"]

required = []

set = { preflight = [true] }

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["preflight", "components", "adapters", "adapter", "operator"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["context", "yes"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/mesheryctl. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.