Skip to content
HALOWERK

Codewerk

repo health

Reads the file tree of the default branch (shallow blobless clone of a public HTTPS repository, a git bundle, or a plain list of paths) and checks community-health files at the locations GitHub searches (.github/, root, docs/), CI configuration (GitHub Actions, GitLab CI, CircleCI, Jenkins, Azure, Travis and others), Dependabot/Renovate config, tests, and binary artifacts by the OpenSSF Scorecard extension list. With repository access it also reads the small health files: README length,.

POST https://code.halowerk.com/v1/repo-health

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
repo_urlstringNoPublic HTTPS clone URL, e.g. https://github.com/owner/repo. No credentials, port 443 only; ssh/git/file URLs are rejected.
bundle_base64stringNoAlternative to repo_url: a git bundle (git bundle create repo.bundle --all), base64-encoded, up to about 180 KB.
refstringNoBranch or tag to analyse instead of the default branch.
filesarrayNoAlternative: repository-relative file paths (e.g. output of git ls-files); content checks are then skipped.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "repo_url": {
      "type": "string",
      "minLength": 12,
      "maxLength": 300,
      "pattern": "^https://\\S+$",
      "description": "Public HTTPS clone URL, e.g. https://github.com/owner/repo. No credentials, port 443 only; ssh/git/file URLs are rejected."
    },
    "bundle_base64": {
      "type": "string",
      "minLength": 24,
      "maxLength": 250000,
      "description": "Alternative to repo_url: a git bundle (git bundle create repo.bundle --all), base64-encoded, up to about 180 KB."
    },
    "ref": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._/-]*$",
      "description": "Branch or tag to analyse instead of the default branch."
    },
    "files": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20000,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "description": "Alternative: repository-relative file paths (e.g. output of git ls-files); content checks are then skipped."
    }
  }
}

Open original schema

Published input example

{
  "repo_url": "https://github.com/octocat/Hello-World"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’