{
  "id": "locust",
  "name": "Locust",
  "homepage": "https://locust.io",
  "description": "An open source load testing tool: define user behaviour with Python code, and swarm your system with millions of simultaneous users.",
  "icon": "SimpleIcons:locust",
  "executables": [
    "locust"
  ],
  "dotfiles": {
    "paths": [
      "~/.locust.conf"
    ],
    "exclude": [],
    "secret": [],
    "side_effect": false
  },
  "commands": {
    "format": 1,
    "label": "Run load test",
    "description": "Run a locustfile, with the web UI or headless. Distributed master/worker options, TLS and logging flags are left out.",
    "quality": "ai-draft",
    "base": "fig:locust",
    "parser": {
      "end_of_options": "--",
      "interleave": "permute",
      "long_equals": true,
      "short_attached": true,
      "short_bundles": false
    },
    "source": [
      {
        "id": "fig",
        "kind": "completion",
        "url": "https://github.com/withfig/autocomplete/blob/master/src/locust.ts",
        "license": "MIT"
      }
    ],
    "field": [
      {
        "id": "locustfile",
        "label": "Locustfile",
        "type": "path",
        "option": [
          "--locustfile",
          "-f"
        ],
        "path": {
          "kind": "file",
          "role": "input"
        },
        "sources": [
          "fig"
        ]
      },
      {
        "id": "host",
        "label": "Target host",
        "description": "For example http://10.21.32.33",
        "type": "string",
        "option": [
          "--host",
          "-H"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "users",
        "label": "Peak concurrent users",
        "type": "integer",
        "option": [
          "--users",
          "-u"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "spawn_rate",
        "label": "Spawn rate (users per second)",
        "type": "number",
        "option": [
          "--spawn-rate",
          "-r"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "run_time",
        "label": "Run time",
        "description": "For example 300s, 20m, 1h30m.",
        "type": "string",
        "option": [
          "--run-time",
          "-t"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "headless",
        "label": "Headless (no web UI)",
        "type": "boolean",
        "option": [
          "--headless"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "web_port",
        "label": "Web UI port",
        "type": "integer",
        "option": [
          "--web-port",
          "-P"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "csv",
        "label": "CSV stats prefix",
        "type": "string",
        "option": [
          "--csv"
        ],
        "sources": [
          "fig"
        ]
      },
      {
        "id": "html",
        "label": "HTML report file",
        "type": "path",
        "option": [
          "--html"
        ],
        "path": {
          "kind": "file",
          "role": "output"
        },
        "effect": "overwrite",
        "sources": [
          "fig"
        ]
      },
      {
        "id": "only_summary",
        "label": "Only print summary",
        "type": "boolean",
        "option": [
          "--only-summary"
        ],
        "sources": [
          "fig"
        ]
      }
    ],
    "task": [
      {
        "id": "headless_run",
        "label": "Headless run",
        "fields": [
          "locustfile",
          "host",
          "users",
          "spawn_rate",
          "run_time",
          "headless"
        ],
        "required": [
          "locustfile",
          "host",
          "users",
          "spawn_rate",
          "run_time"
        ],
        "set": {
          "headless": [
            true
          ]
        }
      },
      {
        "id": "web_ui",
        "label": "Web UI",
        "fields": [
          "locustfile",
          "host",
          "web_port"
        ],
        "required": [
          "locustfile"
        ]
      }
    ],
    "group": [
      {
        "id": "basic",
        "label": "Basic",
        "fields": [
          "locustfile",
          "host",
          "users",
          "spawn_rate",
          "run_time",
          "headless"
        ]
      },
      {
        "id": "advanced",
        "label": "Advanced",
        "fields": [
          "web_port",
          "csv",
          "html",
          "only_summary"
        ]
      }
    ]
  }
}
