pipeline-debugger-cli
v0.3.1
Published
Pipeline Debugger CLI — run GitHub Actions workflows locally in Docker.
Maintainers
Readme
pipeline-debugger-cli (pdbg)
Run GitHub Actions workflows locally (act) or via GitHub runners, and connect them to the Pipeline Debugger dashboard.
Install
npm install -g pipeline-debugger-cliQuickstart
# install prerequisites + setup wizard
pdbg setup
# interactive setup wizard (login + project + daemon)
pdbg start
# or step-by-step
pdbg login
pdbg project add
pdbg daemon
# sanity check (with optional auto-fix)
pdbg doctor --fixOpen https://pipeline-debugger.vercel.app/dashboard and paste the token printed by pdbg daemon.
Commands
pdbg setup– install prerequisites and run setup wizardpdbg start– interactive setup wizardpdbg project add [path]– register a repo (defaults to cwd)pdbg projects– list projectspdbg daemon– start local runner API (HTTPS by default)pdbg doctor– check Docker, auth, and local runner status (--fixto install prerequisites)pdbg run <workflow.yml>– run a workflow file directly
Engines
- act (default): full GitHub Actions support locally (requires
act+ Docker) - github: run on GitHub-hosted runners via
ghCLI (requiresgh auth login) - builtin: runs only
run:steps (fast fallback;uses:skipped)
Examples:
pdbg run .github/workflows/ci.yml --engine act
pdbg run .github/workflows/ci.yml --engine github --repo owner/repo --ref main
pdbg run .github/workflows/ci.yml --engine builtin --image node:20-bullseyeRemote Docker (optional)
If your machine doesn’t have Docker, you can point the CLI to a remote Docker engine:
pdbg daemon --docker-host tcp://your-host:2376 --docker-tls-verify --docker-cert-path ~/.docker
# or for a one-off run
pdbg run .github/workflows/ci.yml --docker-host tcp://your-host:2376 --docker-tls-verify --docker-cert-path ~/.dockerNotes
builtinengine supportsjobs.<job>.steps[].runonly;uses:is skipped.actengine supportsuses:and composite actions (requires Docker + act).githubengine runs workflows on GitHub-hosted runners (requires gh auth).
License
MIT. See LICENSE.
