CLI reference¶

Generated from the complete command tree of the built bin/replicove; start with the CLI walkthrough or use the YAML API.

Global flags select the host kubeconfig, context, and granted destination namespace. The default destination is replica-lab. plan explains the metadata-only capture; status prints sanitized status, not secret payloads or a full rendered diff. install is an initial Helm installation; follow the upgrade guide for an existing installation.

The credential commands refuse to overwrite an existing output file. access uses an existing network route; connect manages a loopback tunnel for an owned runtime. See access.

replicove¶

Your cluster's tools. A fresh place to test.

Usage:
  replicove [command]

Available Commands:
  access      Issue bounded guest credentials; connect also opens a local tunnel
  approve     
  chaos       Run bounded guest faults and verify their rollback
  completion  Generate the autocompletion script for the specified shell
  connect     Issue bounded guest credentials; connect also opens a local tunnel
  create      Capture the granted toolset and provision an ephemeral replica
  dashboard   Open a read-only local dashboard using the selected Kubernetes identity
  database    Validate explicitly granted PostgreSQL copy policies
  delete      
  doctor      Check API availability and caller permissions without provisioning or injecting faults
  help        Help about any command
  install     Install the operator and CRDs as a host administrator
  mcp         Serve MCP over stdio using this process's Kubernetes identity and namespace
  mirror      Create writable workload copies and reset them from host snapshots
  plan        
  pool        Render administrator-managed destinations for concurrent test runs
  refresh     
  run         Create a bounded test replica, run a local command, and verify cleanup
  status      

Flags:
      --context string      Host kubeconfig context
  -h, --help                help for replicove
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")
  -v, --version             version for replicove

Use "replicove [command] --help" for more information about a command.

replicove access¶

Issue bounded guest credentials; connect also opens a local tunnel

Usage:
  replicove access NAME [flags]

Flags:
      --duration-seconds int   Credential duration, capped by grant and replica TTL (default 900)
  -h, --help                   help for access
      --output string          New kubeconfig file; existing files are never overwritten
      --role string            Granted role: viewer, deployer, admin (default "viewer")
      --wait duration          Maximum wait for credential issuance (default 3m0s)

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove approve¶

Usage:
  replicove approve NAME [flags]

Flags:
  -h, --help   help for approve

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove chaos¶

Run bounded guest faults and verify their rollback

Usage:
  replicove chaos [command]

Available Commands:
  create      Create an immutable ReplicaExperiment from YAML
  delete      Stop the experiment; finalizer waits for verified rollback
  status      Show fault phase, deadline, and rollback status

Flags:
  -h, --help   help for chaos

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

Use "replicove chaos [command] --help" for more information about a command.

replicove completion¶

Generate the autocompletion script for replicove for the specified shell.
See each sub-command's help for details on how to use the generated script.

Usage:
  replicove completion [command]

Available Commands:
  bash        Generate the autocompletion script for bash
  fish        Generate the autocompletion script for fish
  powershell  Generate the autocompletion script for powershell
  zsh         Generate the autocompletion script for zsh

Flags:
  -h, --help   help for completion

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

Use "replicove completion [command] --help" for more information about a command.

replicove connect¶

Issue bounded guest credentials; connect also opens a local tunnel

Usage:
  replicove connect NAME [flags]

Flags:
      --duration-seconds int   Credential duration, capped by grant and replica TTL (default 900)
  -h, --help                   help for connect
      --output string          New kubeconfig file; existing files are never overwritten
      --role string            Granted role: viewer, deployer, admin (default "viewer")
      --wait duration          Maximum wait for credential issuance (default 3m0s)

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove create¶

Capture the granted toolset and provision an ephemeral replica

Usage:
  replicove create NAME [flags]

Flags:
      --existing string           Administrator-granted existing target name; preserve its runtime
      --from string               Comma-separated granted source namespaces
      --grant string              Administrator ReplicaGrant name
  -h, --help                      help for create
      --manual                    Require approval of the captured plan before provisioning
      --profile string            Pinned vCluster runtime profile (default "vcluster-0.37.1-persistent")
      --replication-file string   YAML ReplicationSpec with selectors, mappings, and overrides
      --ttl string                Lifetime including provisioning (default "2h")

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove dashboard¶

Open a read-only local dashboard using the selected Kubernetes identity

Usage:
  replicove dashboard [flags]

Flags:
  -h, --help            help for dashboard
      --listen string   Loopback IP:port; port zero chooses an available port (default "127.0.0.1:0")

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove database¶

Validate explicitly granted PostgreSQL copy policies

Usage:
  replicove database [command]

Available Commands:
  validate    Check grant and masking rules locally without connecting to a database

Flags:
  -h, --help   help for database

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

Use "replicove database [command] --help" for more information about a command.

replicove delete¶

Usage:
  replicove delete NAME [flags]

Flags:
  -h, --help   help for delete

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove doctor¶

Check API availability and caller permissions without provisioning or injecting faults

Usage:
  replicove doctor [flags]

Flags:
      --grant string     Inspect one administrator grant
  -h, --help             help for doctor
      --output string    Report format: text or json (default "text")
      --replica string   Include an existing replica's metadata-only plan

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove install¶

Install the operator and CRDs as a host administrator

Usage:
  replicove install [flags]

Flags:
  -h, --help                      help for install
      --image string              Explicit operator repository:tag override
      --system-namespace string   Protected operator and encrypted-state namespace (default "replicove-system")
      --values string             Operator chart values YAML, including source read permissions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mcp¶

Serve MCP over stdio using this process's Kubernetes identity and namespace

Usage:
  replicove mcp [flags]

Flags:
      --allow-write   Expose request mutation tools; Kubernetes RBAC and administrator grants still apply
  -h, --help          help for mcp

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror¶

Create writable workload copies and reset them from host snapshots

Usage:
  replicove mirror [command]

Available Commands:
  access      Access the current mirror generation with expiring credentials
  cancel      Cancel a candidate or remove an unused revision; active revisions remain protected
  connect     Access the current mirror generation with expiring credentials
  create      Create a mirror from a ReplicaMirror YAML manifest
  delete      Delete the mirror and clean up its owned data
  hold        Delay generation replacement for an active test
  release     Release the active test lease
  reset       Rebuild from a retained capture revision
  resume      Resume automatic sync requests
  revisions   List capture revisions and run status
  status      Show active and pending mirror generations
  suspend     Stop automatic sync requests
  sync        Capture latest host data and prepare a replacement

Flags:
  -h, --help   help for mirror

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

Use "replicove mirror [command] --help" for more information about a command.

replicove plan¶

Usage:
  replicove plan NAME [flags]

Flags:
  -h, --help   help for plan
      --json   Emit a metadata-only structured plan report

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove pool¶

Render administrator-managed destinations for concurrent test runs

Usage:
  replicove pool [command]

Available Commands:
  render      Render native installation YAML offline; no cluster access or grants are created

Flags:
  -h, --help   help for pool

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

Use "replicove pool [command] --help" for more information about a command.

replicove refresh¶

Usage:
  replicove refresh NAME [flags]

Flags:
  -h, --help   help for refresh

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove run¶

Create a bounded test replica, run a local command, and verify cleanup

Usage:
  replicove run -f RECIPE.yaml [-- COMMAND ARG...] [flags]

Flags:
      --artifacts string   New private directory for JSON provenance and JUnit results
  -f, --file string        Local TestRecipe YAML file
  -h, --help               help for run

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove status¶

Usage:
  replicove status NAME [flags]

Flags:
  -h, --help   help for status

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove chaos create¶

Create an immutable ReplicaExperiment from YAML

Usage:
  replicove chaos create NAME [flags]

Flags:
  -f, --file string   ReplicaExperiment manifest
  -h, --help          help for create

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove chaos delete¶

Stop the experiment; finalizer waits for verified rollback

Usage:
  replicove chaos delete NAME [flags]

Flags:
  -h, --help   help for delete

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove chaos status¶

Show fault phase, deadline, and rollback status

Usage:
  replicove chaos status NAME [flags]

Flags:
  -h, --help   help for status

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove completion bash¶

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

    source <(replicove completion bash)

To load completions for every new session, execute once:

#### Linux:

    replicove completion bash > /etc/bash_completion.d/replicove

#### macOS:

    replicove completion bash > $(brew --prefix)/etc/bash_completion.d/replicove

You will need to start a new shell for this setup to take effect.

Usage:
  replicove completion bash

Flags:
  -h, --help              help for bash
      --no-descriptions   disable completion descriptions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove completion fish¶

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

    replicove completion fish | source

To load completions for every new session, execute once:

    replicove completion fish > ~/.config/fish/completions/replicove.fish

You will need to start a new shell for this setup to take effect.

Usage:
  replicove completion fish [flags]

Flags:
  -h, --help              help for fish
      --no-descriptions   disable completion descriptions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove completion powershell¶

Generate the autocompletion script for powershell.

To load completions in your current shell session:

    replicove completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.

Usage:
  replicove completion powershell [flags]

Flags:
  -h, --help              help for powershell
      --no-descriptions   disable completion descriptions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove completion zsh¶

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it.  You can execute the following once:

    echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

    source <(replicove completion zsh)

To load completions for every new session, execute once:

#### Linux:

    replicove completion zsh > "${fpath[1]}/_replicove"

#### macOS:

    replicove completion zsh > $(brew --prefix)/share/zsh/site-functions/_replicove

You will need to start a new shell for this setup to take effect.

Usage:
  replicove completion zsh [flags]

Flags:
  -h, --help              help for zsh
      --no-descriptions   disable completion descriptions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove database validate¶

Check grant and masking rules locally without connecting to a database

Usage:
  replicove database validate [flags]

Flags:
      --grant-file string         Administrator ReplicaGrant YAML
  -h, --help                      help for validate
      --replication-file string   ReplicationSpec YAML
      --state-namespace string    Protected operator namespace holding database credential Secrets (default "replicove-system")

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror access¶

Access the current mirror generation with expiring credentials

Usage:
  replicove mirror access NAME [flags]

Flags:
      --duration-seconds int   Credential duration, capped by grant and replica TTL (default 900)
  -h, --help                   help for access
      --output string          New kubeconfig file; existing files are never overwritten
      --role string            Granted role: viewer, deployer, admin (default "viewer")
      --wait duration          Maximum wait for credential issuance (default 3m0s)

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror cancel¶

Cancel a candidate or remove an unused revision; active revisions remain protected

Usage:
  replicove mirror cancel RUN [flags]

Flags:
  -h, --help   help for cancel

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror connect¶

Access the current mirror generation with expiring credentials

Usage:
  replicove mirror connect NAME [flags]

Flags:
      --duration-seconds int   Credential duration, capped by grant and replica TTL (default 900)
  -h, --help                   help for connect
      --output string          New kubeconfig file; existing files are never overwritten
      --role string            Granted role: viewer, deployer, admin (default "viewer")
      --wait duration          Maximum wait for credential issuance (default 3m0s)

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror create¶

Create a mirror from a ReplicaMirror YAML manifest

Usage:
  replicove mirror create NAME [flags]

Flags:
  -f, --file string   ReplicaMirror manifest
  -h, --help          help for create

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror delete¶

Delete the mirror and clean up its owned data

Usage:
  replicove mirror delete NAME [flags]

Flags:
  -h, --help   help for delete

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror hold¶

Delay generation replacement for an active test

Usage:
  replicove mirror hold NAME [flags]

Flags:
      --duration duration   Pin the active test generation for at most 30m (default 15m0s)
  -h, --help                help for hold

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror release¶

Release the active test lease

Usage:
  replicove mirror release NAME [flags]

Flags:
  -h, --help   help for release

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror reset¶

Rebuild from a retained capture revision

Usage:
  replicove mirror reset NAME [flags]

Flags:
      --force             Bypass the test lease only if the administrator grant permits it
  -h, --help              help for reset
      --revision string   Retained Sync run name
      --run-name string   Explicit unique request name; retries with the same request are idempotent

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror resume¶

Resume automatic sync requests

Usage:
  replicove mirror resume NAME [flags]

Flags:
  -h, --help   help for resume

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror revisions¶

List capture revisions and run status

Usage:
  replicove mirror revisions NAME [flags]

Flags:
  -h, --help   help for revisions

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror status¶

Show active and pending mirror generations

Usage:
  replicove mirror status NAME [flags]

Flags:
  -h, --help   help for status

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror suspend¶

Stop automatic sync requests

Usage:
  replicove mirror suspend NAME [flags]

Flags:
  -h, --help   help for suspend

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove mirror sync¶

Capture latest host data and prepare a replacement

Usage:
  replicove mirror sync NAME [flags]

Flags:
      --force             Bypass the test lease only if the administrator grant permits it
  -h, --help              help for sync
      --run-name string   Explicit unique request name; retries with the same request are idempotent

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")

replicove pool render¶

Render native installation YAML offline; no cluster access or grants are created

Usage:
  replicove pool render -f POOL.yaml [flags]

Flags:
  -f, --file string   Local administrator ReplicaPool file
  -h, --help          help for render

Global Flags:
      --context string      Host kubeconfig context
      --kubeconfig string   Host kubeconfig path
  -n, --namespace string    Administrator-granted destination namespace (default "replica-lab")