Skip to content
HALOWERK

Denkwerk

readme quickstart

Reads the README (Markdown code blocks in shell languages, prompts stripped, multi-line commands joined) and classifies commands into clone, install, configure, build, run and test; then fills missing phases from manifests: package.json (scripts, engines, packageManager), pyproject.toml (TOML subset: project, requires-python, scripts, Poetry and uv), requirements.txt, Makefile targets, Dockerfile (FROM, EXPOSE, CMD), docker-compose ports, Cargo.toml, go.mod and .env.example variables. Every.

POST https://denk.halowerk.com/v1/readme-quickstart

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
readmestringNo
filesobjectNoMap of repository paths to file contents, e.g. {"package.json": "..."}.
repostringNoPublic GitHub repository owner/name.
refstringNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "readme": {
      "type": "string",
      "maxLength": 1000000
    },
    "files": {
      "type": "object",
      "maxProperties": 15,
      "additionalProperties": {
        "type": "string",
        "maxLength": 300000
      },
      "description": "Map of repository paths to file contents, e.g. {\"package.json\": \"...\"}."
    },
    "repo": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]{1,100}/[A-Za-z0-9_.-]{1,100}$",
      "description": "Public GitHub repository owner/name."
    },
    "ref": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._/-]{1,100}$",
      "default": "HEAD"
    }
  }
}

Open original schema

Published input example

{
  "readme": "## Install\n\n```bash\nnpm install\n```\n\n## Run\n\n```bash\nnpm run dev\n```",
  "files": {
    "package.json": "{\"name\":\"demo\",\"engines\":{\"node\":\">=20\"},\"scripts\":{\"dev\":\"vite\",\"test\":\"vitest\"}}"
  }
}

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 โ†’