sklp deploy mesh

sklp deploy mesh

Description

Inspect the WireGuard mesh as the node sees it (ls | rm <id>)

Subcommands

Technical details

Technical details

Raw command JSON

{
  "path": [
    "sklp",
    "deploy",
    "mesh"
  ],
  "slug": "deploy-mesh",
  "name": "mesh",
  "short": "Inspect the WireGuard mesh as the node sees it (ls | rm <id>)",
  "synopsis": "sklp deploy mesh",
  "subcommands": [
    {
      "path": [
        "sklp",
        "deploy",
        "mesh",
        "ls"
      ],
      "slug": "deploy-mesh-ls",
      "name": "ls",
      "short": "List the mesh peers meshauthority knows",
      "synopsis": "sklp deploy mesh ls [flags]",
      "flags": [
        {
          "name": "json",
          "usage": "emit JSON on stdout (the form for scripts and AI agents)",
          "type": "bool"
        },
        {
          "name": "server",
          "aliases": [
            "addr"
          ],
          "usage": "remote supervisor control API (https://host:9443); when set, pilot it over the network instead of the local socket",
          "type": "string"
        },
        {
          "name": "token",
          "usage": "Bearer token for --server (prefer --token-file or SKLP_CONTEXT_TOKEN to keep it out of the process list)",
          "type": "string"
        },
        {
          "name": "token-file",
          "usage": "file holding the Bearer token for --server",
          "type": "string"
        },
        {
          "name": "ca-fingerprint",
          "usage": "pin the server certificate by its sha256 fingerprint (printed by the server / `sklp deploy fingerprint`)",
          "type": "string"
        },
        {
          "name": "insecure",
          "usage": "skip TLS verification for --server (LAN bootstrap only; prefer --ca-fingerprint)",
          "type": "bool"
        },
        {
          "name": "context",
          "usage": "deploy context to read server/token/ca-fingerprint from (default: the active context)",
          "type": "string"
        },
        {
          "name": "config",
          "usage": "path to a config file to read (one file per node/VM, e.g. lungor.yaml); overrides the default ~/.config/sklp/config.yaml",
          "type": "string"
        }
      ]
    },
    {
      "path": [
        "sklp",
        "deploy",
        "mesh",
        "rm"
      ],
      "slug": "deploy-mesh-rm",
      "name": "rm",
      "short": "Forget a mesh peer silent for 2 minutes (a rebuilt node's old identity); its mesh IP returns to the pool",
      "synopsis": "sklp deploy mesh rm [flags] <id>",
      "flags": [
        {
          "name": "server",
          "aliases": [
            "addr"
          ],
          "usage": "remote supervisor control API (https://host:9443); when set, pilot it over the network instead of the local socket",
          "type": "string"
        },
        {
          "name": "token",
          "usage": "Bearer token for --server (prefer --token-file or SKLP_CONTEXT_TOKEN to keep it out of the process list)",
          "type": "string"
        },
        {
          "name": "token-file",
          "usage": "file holding the Bearer token for --server",
          "type": "string"
        },
        {
          "name": "ca-fingerprint",
          "usage": "pin the server certificate by its sha256 fingerprint (printed by the server / `sklp deploy fingerprint`)",
          "type": "string"
        },
        {
          "name": "insecure",
          "usage": "skip TLS verification for --server (LAN bootstrap only; prefer --ca-fingerprint)",
          "type": "bool"
        },
        {
          "name": "context",
          "usage": "deploy context to read server/token/ca-fingerprint from (default: the active context)",
          "type": "string"
        },
        {
          "name": "config",
          "usage": "path to a config file to read (one file per node/VM, e.g. lungor.yaml); overrides the default ~/.config/sklp/config.yaml",
          "type": "string"
        }
      ],
      "positionals": [
        {
          "name": "id",
          "required": true
        }
      ]
    }
  ]
}

See also