mtv-cli-docs

name: mtv-cli-docs description: Find kubectl-mtv CLI documentation links and usage guidance. Use when the user asks about kubectl-mtv commands, CLI migration workflows, TSL query syntax, KARL affinity rules, provider setup via CLI, inventory queries, plan creation flags, or any kubectl-mtv technical guide topic.

kubectl-mtv CLI Technical Guide

Use this TOC to suggest the most relevant documentation link when a user asks about kubectl-mtv CLI topics. Always link to the specific chapter page. Base URL: https://yaacov.github.io/kubectl-mtv/guide/

Getting Command Help

For detailed flags, syntax, and examples of any kubectl-mtv command, use the MTV MCP mtv_help tool:

mtv_help("<command>")

Examples:

• mtv_help("create plan") — all flags and examples for plan creation
• mtv_help("get inventory") — inventory query syntax and options
• mtv_help("patch planvm") — per-VM patching flags
• mtv_help("settings") — settings management subcommands

Always call mtv_help before constructing an unfamiliar command to get the correct and current flags.

Translating MCP Tool Calls to CLI Commands

Note for human users: This section translates MCP tool calls into equivalent kubectl mtv CLI commands you can run manually in your terminal.

When showing users the equivalent CLI command, follow these rules.

Rule 1: Base command

The command field maps to kubectl mtv <command>:

{command: "start plan", ...}  →  kubectl mtv start plan ...
{command: "get inventory vm", ...}  →  kubectl mtv get inventory vm ...

Rule 2: Flags use --the-flag-key (NO positional arguments)

Every key in the flags object becomes a double-dash flag on the CLI: key: "val" → --key val. kubectl mtv has NO positional arguments — resource names MUST use --name.

kubectl mtv start plan --name my-migration -n ns

Rule 3: Boolean flags

true → include the flag with no value. false or absent → omit it.

{flags: {dry-run: true}}  →  --dry-run
{flags: {all: true}}      →  --all
{flags: {vms: true}}      →  --vms

Rule 4: Always append -n <namespace>

The MCP server injects namespace automatically, but CLI commands need it explicitly. Always add -n <namespace> (or --all-namespaces).

Translation examples

MCP tool call:

mtv_write {command: "create plan", flags: {name: "my-mig", source: "vsphere-prod", vms: "vm1,vm2"}}

CLI:

kubectl mtv create plan --name my-mig --source vsphere-prod --vms "vm1,vm2" -n <ns>

MCP tool call:

mtv_write {command: "start plan", flags: {name: "my-mig"}}

CLI:

kubectl mtv start plan --name my-mig -n <ns>

MCP tool call:

mtv_read {command: "get plan", flags: {name: "my-mig", vms: true, disk: true}}

CLI:

kubectl mtv get plan --name my-mig --vms --disk -n <ns>

MCP tool call:

mtv_read {command: "describe plan", flags: {name: "my-mig"}}

CLI:

kubectl mtv describe plan --name my-mig -n <ns>

MCP tool call:

mtv_write {command: "delete plan", flags: {name: "my-mig", clean-all: true}}

CLI:

kubectl mtv delete plan --name my-mig --clean-all -n <ns>

I. Introduction and Fundamentals

II. Provider, Host, and VDDK Management

III. Inventory and Query Language

IV. Mapping and Plan Configuration

V. Advanced Migration Customization

VI. Operations, Debugging, and AI

VII. Reference and Appendices

Quick Topic Finder

Use this to match user questions to the right documentation link.

• "How do I install kubectl-mtv?" → Ch 2: Installation
• "How do I create a provider?" → Ch 6: Provider Management
• "How do I list VMs / query inventory?" → Ch 9: Inventory
• "How do I filter VMs with queries?" → Ch 10: Query Language or Ch 27: TSL Reference
• "How do I create a migration plan?" → Ch 13: Plan Creation
• "What flags does create plan accept?" → Ch 26: Command Reference
• "How do I map networks/storage?" → Ch 11: Mapping Management
• "How do I start a migration?" → Ch 19: Plan Lifecycle
• "Cold vs warm vs live migration?" → Ch 4: Migration Types
• "How do I set up VDDK?" → Ch 8: VDDK Image
• "How do I use hooks?" → Ch 17: Migration Hooks
• "How do I control VM placement / affinity?" → Ch 15: Target VM Placement or Ch 28: KARL Reference
• "How do I patch a plan / VM?" → Ch 18: Advanced Patching
• "How do I check system health?" → Ch 24: Health Checks
• "How do I configure settings?" → Ch 25: Settings
• "How do I customize per-VM settings?" → Ch 14: PlanVMS Format
• "How do I optimize convertor pods?" → Ch 16: Convertor Optimization
• "Storage array offloading?" → Ch 12: Storage Offloading
• "Migration is failing / troubleshooting" → Ch 20: Troubleshooting
• "MCP server / AI integration?" → Ch 22: MCP Server
• "What is TSL / query syntax?" → Ch 27: TSL Reference
• "What is KARL / affinity syntax?" → Ch 28: KARL Reference
• "Best practices / security?" → Ch 21: Best Practices
• "ESXi migration hosts?" → Ch 7: Migration Hosts
• "Conversion migration?" → Ch 5: Conversion Migration
• "KubeVirt / virtctl after migration?" → Ch 23: KubeVirt Tools