{
  "id": "fabric",
  "name": "Fabric",
  "homepage": "https://www.fabfile.org/",
  "description": "Library and command-line tool for SSH",
  "executables": [
    "fab"
  ],
  "dotfiles": {
    "paths": [],
    "secret": [
      "~/.fabric.yaml",
      "~/.fabric.yml",
      "~/.fabric.json",
      "~/.fabric.py",
      "~/.fabricrc"
    ]
  },
  "commands": {
    "format": 1,
    "label": "Run fabfile tasks",
    "description": "Run tasks from a fabfile.py over SSH against a list of hosts, or list the available tasks. Collections, config files, task arguments and sudo prompts are left out.",
    "quality": "ai-draft",
    "parser": {
      "end_of_options": "--",
      "interleave": "permute",
      "long_equals": true,
      "short_attached": true,
      "short_bundles": false
    },
    "source": [
      {
        "id": "docs",
        "kind": "manual",
        "url": "https://docs.fabfile.org/en/stable/cli.html",
        "revision": "3.x stable",
        "evidence": "-H, --hosts\nTakes a comma-separated string listing hostnames against which tasks should be executed, in serial.\n-i, --identity\nTypically this can be thought of as identical to ssh -i <path>, i.e. supplying a specific, runtime private key file.\n--prompt-for-login-password\n--prompt-for-passphrase\n-S, --ssh-config\nTakes a path to load as a runtime SSH config file.\n-t, --connect-timeout\nTakes an integer of seconds after which connection should time out.\n$ fab --hosts host1,host2,host3 taskA taskB\nfab --list\n"
      },
      {
        "id": "invoke",
        "kind": "manual",
        "url": "https://docs.pyinvoke.org/en/stable/invoke.html",
        "revision": "stable",
        "evidence": "-d, --debug\n--dry\n-e, --echo\n-l, --list=STRING\n-p, --pty\n-r STRING, --search-root=STRING\n-w, --warn-only\n"
      }
    ],
    "field": [
      {
        "id": "tasks",
        "label": "Tasks",
        "description": "Task names from fabfile.py, run in this order for each host.",
        "type": "string",
        "position": 0,
        "multiple": true,
        "sources": [
          "docs"
        ]
      },
      {
        "id": "hosts",
        "label": "Hosts",
        "description": "Comma-separated list of hostnames, for example host1,host2.",
        "type": "string",
        "option": [
          "--hosts",
          "-H"
        ],
        "sources": [
          "docs"
        ]
      },
      {
        "id": "identity",
        "label": "SSH private key",
        "type": "path",
        "option": [
          "--identity",
          "-i"
        ],
        "path": {
          "kind": "file",
          "role": "input",
          "must_exist": true
        },
        "sources": [
          "docs"
        ]
      },
      {
        "id": "ssh_config",
        "label": "SSH config file",
        "type": "path",
        "option": [
          "--ssh-config",
          "-S"
        ],
        "path": {
          "kind": "file",
          "role": "input",
          "must_exist": true
        },
        "sources": [
          "docs"
        ]
      },
      {
        "id": "connect_timeout",
        "label": "Connect timeout (seconds)",
        "type": "integer",
        "option": [
          "--connect-timeout",
          "-t"
        ],
        "min": 1,
        "sources": [
          "docs"
        ]
      },
      {
        "id": "prompt_login_password",
        "label": "Prompt for login password",
        "type": "boolean",
        "option": [
          "--prompt-for-login-password"
        ],
        "sources": [
          "docs"
        ]
      },
      {
        "id": "prompt_passphrase",
        "label": "Prompt for key passphrase",
        "type": "boolean",
        "option": [
          "--prompt-for-passphrase"
        ],
        "sources": [
          "docs"
        ]
      },
      {
        "id": "list",
        "label": "List tasks",
        "description": "List available tasks instead of running any.",
        "type": "boolean",
        "option": [
          "--list",
          "-l"
        ],
        "sources": [
          "invoke"
        ]
      },
      {
        "id": "echo",
        "label": "Echo commands",
        "type": "boolean",
        "option": [
          "--echo",
          "-e"
        ],
        "sources": [
          "invoke"
        ]
      },
      {
        "id": "dry",
        "label": "Dry run",
        "type": "boolean",
        "option": [
          "--dry"
        ],
        "sources": [
          "invoke"
        ]
      },
      {
        "id": "pty",
        "label": "Use a pty",
        "type": "boolean",
        "option": [
          "--pty",
          "-p"
        ],
        "sources": [
          "invoke"
        ]
      },
      {
        "id": "warn_only",
        "label": "Warn only on failures",
        "type": "boolean",
        "option": [
          "--warn-only",
          "-w"
        ],
        "sources": [
          "invoke"
        ]
      }
    ],
    "task": [
      {
        "id": "run",
        "label": "Run tasks on hosts",
        "fields": [
          "tasks",
          "hosts",
          "identity",
          "echo"
        ],
        "required": [
          "tasks",
          "hosts"
        ]
      },
      {
        "id": "list",
        "label": "List tasks",
        "fields": [
          "list"
        ],
        "set": {
          "list": [
            true
          ]
        },
        "lock": [
          "list"
        ]
      }
    ],
    "group": [
      {
        "id": "basic",
        "label": "Basic",
        "fields": [
          "tasks",
          "hosts",
          "identity",
          "list"
        ]
      },
      {
        "id": "advanced",
        "label": "Advanced",
        "fields": [
          "ssh_config",
          "connect_timeout",
          "prompt_login_password",
          "prompt_passphrase",
          "echo",
          "dry",
          "pty",
          "warn_only"
        ]
      }
    ]
  }
}