{
  "id": "nerdctl",
  "name": "nerdctl",
  "homepage": "https://github.com/containerd/nerdctl",
  "description": "A Docker-compatible CLI for containerd.",
  "executables": [
    "nerdctl"
  ],
  "dotfiles": {
    "paths": [
      "[configHome]/nerdctl/nerdctl.toml"
    ],
    "exclude": [],
    "secret": [],
    "side_effect": false
  },
  "commands": {
    "format": 1,
    "label": "nerdctl",
    "description": "Run a container from an image. Networking, resource limits, platform and other nerdctl subcommands are left out.",
    "quality": "ai-draft",
    "parser": {
      "end_of_options": "--",
      "interleave": "permute",
      "long_equals": true,
      "short_attached": false,
      "short_bundles": false
    },
    "subcommand": [
      {
        "path": [
          "run"
        ],
        "label": "Run a container",
        "source": [
          {
            "id": "help",
            "kind": "manual",
            "url": "https://raw.githubusercontent.com/containerd/nerdctl/HEAD/docs/command-reference.md",
            "revision": "HEAD 2026-10",
            "evidence": "Usage: `nerdctl run [OPTIONS] IMAGE [COMMAND] [ARG...]`\n- :whale: `-i, --interactive`: Keep STDIN open even if not attached\n- :whale: `-t, --tty`: Allocate a pseudo-TTY\n- :whale: `-d, --detach`: Run container in background and print container ID\n- :whale: `--rm`: Automatically remove the container when it exits\n- :whale: `-u, --user`: Username or UID (format: <name|uid>[:<group|gid>])\n- :whale: `-v, --volume <SRC>:<DST>[:<OPT>]`: Bind mount a volume, e.g., `-v /mnt:/mnt:ro`\n- :whale: `-w, --workdir`: Working directory inside the container\n- :whale: `-e, --env`: Set environment variables\n- :whale: `--name`: Assign a name to the container\n- :whale: `-p, --publish`: Publish a container's port(s) to the host\n- :whale: `--entrypoint`: Overwrite the default ENTRYPOINT of the image\n"
          }
        ],
        "field": [
          {
            "id": "interactive",
            "label": "Keep STDIN open",
            "type": "boolean",
            "option": [
              "--interactive",
              "-i"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "tty",
            "label": "Allocate a TTY",
            "type": "boolean",
            "option": [
              "--tty",
              "-t"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "detach",
            "label": "Run in background",
            "type": "boolean",
            "option": [
              "--detach",
              "-d"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "rm",
            "label": "Remove when it exits",
            "type": "boolean",
            "option": [
              "--rm"
            ],
            "effect": "delete",
            "sources": [
              "help"
            ]
          },
          {
            "id": "name",
            "label": "Container name",
            "type": "string",
            "option": [
              "--name"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "publish",
            "label": "Publish ports",
            "description": "For example 8080:80.",
            "type": "string",
            "option": [
              "--publish",
              "-p"
            ],
            "multiple": true,
            "sources": [
              "help"
            ]
          },
          {
            "id": "volume",
            "label": "Volumes",
            "description": "SRC:DST[:OPT], e.g. /mnt:/mnt:ro.",
            "type": "string",
            "option": [
              "--volume",
              "-v"
            ],
            "multiple": true,
            "sources": [
              "help"
            ]
          },
          {
            "id": "env",
            "label": "Environment variables",
            "type": "string",
            "option": [
              "--env",
              "-e"
            ],
            "multiple": true,
            "sources": [
              "help"
            ]
          },
          {
            "id": "workdir",
            "label": "Working directory",
            "type": "string",
            "option": [
              "--workdir",
              "-w"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "user",
            "label": "User",
            "type": "string",
            "option": [
              "--user",
              "-u"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "entrypoint",
            "label": "Entrypoint",
            "type": "string",
            "option": [
              "--entrypoint"
            ],
            "sources": [
              "help"
            ]
          },
          {
            "id": "image",
            "label": "Image",
            "type": "string",
            "position": 0,
            "sources": [
              "help"
            ]
          },
          {
            "id": "command",
            "label": "Command and arguments",
            "type": "string",
            "position": 1,
            "multiple": true,
            "sources": [
              "help"
            ]
          }
        ],
        "task": [
          {
            "id": "shell",
            "label": "Interactive throwaway container",
            "fields": [
              "image",
              "interactive",
              "tty",
              "rm",
              "command"
            ],
            "required": [
              "image"
            ],
            "set": {
              "interactive": [
                true
              ],
              "tty": [
                true
              ],
              "rm": [
                true
              ]
            }
          },
          {
            "id": "service",
            "label": "Background service",
            "fields": [
              "image",
              "detach",
              "name",
              "publish"
            ],
            "required": [
              "image"
            ],
            "set": {
              "detach": [
                true
              ]
            }
          }
        ],
        "group": [
          {
            "id": "basic",
            "label": "Basic",
            "fields": [
              "image",
              "command",
              "interactive",
              "tty",
              "detach",
              "rm",
              "name",
              "publish"
            ]
          },
          {
            "id": "advanced",
            "label": "Advanced",
            "fields": [
              "volume",
              "env",
              "workdir",
              "user",
              "entrypoint"
            ]
          }
        ]
      }
    ]
  }
}