Skip to main content

jenkinsfilelint-engine

Check a Jenkinsfile without a Jenkins controller: no server, no Docker, no JVM. One ~500 KB binary that checks Groovy syntax and Declarative Pipeline structure, and reports errors with the same wording as Jenkins's own validator.

This is the offline engine of jenkinsfilelint: it runs for --offline, the jenkinsfilelint-offline pre-commit hook, and whenever no Jenkins server is configured. Most people want jenkinsfilelint itself, which installs this package. The remote and Docker modes of jenkinsfilelint stay the exact check; this one is the fast one. See DESIGN.md.

$ jenkinsfilelint-engine Jenkinsfile
Jenkinsfile:2:5: error: Not a valid section definition: "agent". Some extra configuration is required.
Jenkinsfile:9:9: error: Expected one of "steps", "stages", or "parallel" for stage "Test"
Jenkinsfile:10:13: error: Unknown stage section "step". Starting with version 0.5, steps in a stage must be in a ‘steps’ block.

Install

pip install jenkinsfilelint-engine

PyPI has prebuilt wheels for Linux (x86_64, aarch64, i686, armv7; glibc and musl), macOS (x86_64, arm64) and Windows (x86_64, x86), for any Python 3.10+. The wheel puts the jenkinsfilelint-engine binary in the environment's scripts directory; python -m jenkinsfilelint_engine runs it too, and jenkinsfilelint_engine.find_bin() returns its path. On other platforms pip builds it from the sdist, which needs a Rust toolchain.

Build and run

cd crates/jenkinsfilelint
cargo build --release
./target/release/jenkinsfilelint-engine path/to/Jenkinsfile [more files...]
./target/release/jenkinsfilelint-engine --format json Jenkinsfile

Exit code is 0 when no file has an error, 1 when any does, and 2 for usage errors. Warnings do not fail the run.

--format json prints one object per file:

[{"file": "Jenkinsfile", "declarative": true, "diagnostics": [
  {"line": 2, "column": 5, "severity": "error", "message": "Not a valid section definition: ..."}]},
 {"file": "vars/notify.groovy", "declarative": false, "diagnostics": []},
 {"file": "missing", "error": "No such file or directory (os error 2)"}]

declarative is false when the file has no pipeline block (a Scripted Pipeline, a shared-library step, plain Groovy): its Groovy syntax was checked, but there was no Declarative structure to check.

What it checks

  • Groovy syntax, including every string form ('...', "${...}", triple-quoted, slashy, dollar-slashy), command calls with named arguments (sh script: 'ls', returnStdout: true), trailing closures, @Library(...) _, method and class definitions.
  • Declarative structure: required agent and stages; allowed and duplicate sections; each stage has exactly one of steps, stages, parallel or matrix; no nested parallel/matrix; agent forms and built-in agent parameters; environment keys and values; options, triggers, parameters, tools, libraries, input; when conditions and their nesting; post conditions; matrix axes and excludes; steps that are blocked in Declarative (stage, properties, mixed parallel); pipeline {} inside the block of another step (node { pipeline { } }).

What it cannot check

Anything that depends on the plugins installed on a controller:

  • whether a step exists and takes the given parameters,
  • agent types added by plugins (reported as a warning, not an error),
  • tool installations configured on the controller,
  • script-security sandbox rules.

Use the remote or --local Docker mode of jenkinsfilelint for those.

How close is it to the official validator?

The pipeline-model-definition plugin ships the test Jenkinsfiles for Jenkins's own validator. Running the offline linter over them:

Result
Valid files with no false errors 287 / 287
Invalid files caught 90 / 90
... with the same message as Jenkins 90 / 90
Invalid files that need plugins or a controller to judge 33 (not counted above)

Reproduce with:

cargo build --release
python3 scripts/corpus_check.py   # clones the plugin at a pinned commit

Development

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test
python3 scripts/corpus_check.py
pip install .   # builds the wheel with maturin and installs it

When the engine changes, bump version in Cargo.toml and the jenkinsfilelint-engine== pin in the root pyproject.toml together.

cargo test also lints every case in tests/jenkins/ and compares the result with tests/jenkins/expected.txt, which records what Jenkins's own validator said about the same file and explains each known difference.

Metadata

Release files for jenkinsfilelint-engine 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jenkinsfilelint-engine 0.3.0
File Size Uploaded Provenance Actions
jenkinsfilelint_engine-0.3.0.tar.gz 117.0 kB With provenance Details for jenkinsfilelint_engine-0.3.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for jenkinsfilelint-engine 0.3.0
File Actions
jenkinsfilelint_engine-0.3.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for jenkinsfilelint_engine-0.3.0-py3-none-win_amd64.whl
jenkinsfilelint_engine-0.3.0-py3-none-win32.whl Python 3 none Windows x86-32 Details for jenkinsfilelint_engine-0.3.0-py3-none-win32.whl
jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details for jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_x86_64.whl
jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_i686.whl Python 3 none Linux musl 1.2+ x86-32 Details for jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_i686.whl
jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_armv7l.whl Python 3 none Linux musl 1.2+ ARMv7l Details for jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_armv7l.whl
jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details for jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_aarch64.whl
jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl Python 3 none Linux glibc 2.17+ x86-32 Details for jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl Python 3 none Linux glibc 2.17+ ARMv7l Details for jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
jenkinsfilelint_engine-0.3.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for jenkinsfilelint_engine-0.3.0-py3-none-macosx_11_0_arm64.whl
jenkinsfilelint_engine-0.3.0-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for jenkinsfilelint_engine-0.3.0-py3-none-macosx_10_12_x86_64.whl

Total release size: 4.4 MB

Release files / jenkinsfilelint_engine-0.3.0.tar.gz

Download URL jenkinsfilelint_engine-0.3.0.tar.gz
Size 117.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a67742f68e9fc36fef36c1ad09920bd098e93acc74e19d8bd827d6826da2fde8
BLAKE2b-256 checksum
How to use checksums
7e65dbc4bc90a97009890179d5a45257a01a1a21deb5a74adb1769f0ac0ddcaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-win_amd64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-win_amd64.whl
Size 284.9 kB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
5ff2a260b74ee5491bc88a5916363452aeea3b803d4bd8dd8cf553ef28aae0dd
BLAKE2b-256 checksum
How to use checksums
978768349df042797d88a5bd7d85e62e0b5392a0e125902c84c7655ac4c062e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-win32.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-win32.whl
Size 267.0 kB
Tags Python 3 Windows x86-32
SHA-256 checksum
How to use checksums
ea23a2d917c50726b82d9a987d248907f283a15ca6029fc9a3b7c0fc6cee76ef
BLAKE2b-256 checksum
How to use checksums
6a567fae10c1aa2dfeb02e592bcee6476cd667954b83a56fc0a3281a68d4fb75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_x86_64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_x86_64.whl
Size 421.5 kB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
c6b1c09fd4a16b6941703c8bbaf666636e5464ca5f9a1be842941eff771cbf34
BLAKE2b-256 checksum
How to use checksums
1012617ad7b84704cc06532038edee3aa1980c2621ef5fd9a15d716f8938fba9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_i686.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_i686.whl
Size 426.3 kB
Tags Linux musl 1.2+ x86-32 Python 3
SHA-256 checksum
How to use checksums
99b3d005def1ac8071ff7241b961cb9e6f09bb1a2d62694e11713a7f7490926b
BLAKE2b-256 checksum
How to use checksums
707a3859b32ff7bccae7377e92ed386a8ef97da1bf0aa06ca42288ce5c6d4943
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_armv7l.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_armv7l.whl
Size 383.3 kB
Tags Linux musl 1.2+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
b72040402d1e7ace637ce5d4dfc5abf768a9a86df1c15b25f7cba7c55dd73bf1
BLAKE2b-256 checksum
How to use checksums
fd5c458acf3555730b21de3630a08424c695a66e86ee97e8ba4b1f01830dd03f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_aarch64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-musllinux_1_2_aarch64.whl
Size 398.6 kB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
8ff91626e7cda6de61e77dab6e37d5a7287882803530eb7a2bfb71ec1d67d098
BLAKE2b-256 checksum
How to use checksums
9eeed3ff3e9017373c29e29f939482ce19e5dee32015e8e1706638e9bfdd736f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 368.7 kB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
930e2c1628e9defef79d49eaa91d88326fed0f15ff0fc818b5a0fcec9f6e818f
BLAKE2b-256 checksum
How to use checksums
b2b6a1bd50911e50f4191c0de48d30f6a98111fda065145919746e0413fe484b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Size 384.6 kB
Tags Linux glibc 2.17+ x86-32 Python 3
SHA-256 checksum
How to use checksums
52e8d66d0926ecd5947b6df629c8fdbf91c059548c4766563a39526573f59f47
BLAKE2b-256 checksum
How to use checksums
19676c02eef648745874d4123f0cd12fa2a88d3b8d0acada21f0d6dd3b1c10c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Size 355.2 kB
Tags Linux glibc 2.17+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
433443cef8ba0c980c1baa404bae31a490566233134f35ac20af4a486688833b
BLAKE2b-256 checksum
How to use checksums
1c55fcbda1cd9c0941a79177a3ffbadf9390adb947c9293d621f5429c92764a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 351.0 kB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
028da662890638c7c571e51f531f7d93c1f8ed22918750a7932abc57ab6e70bf
BLAKE2b-256 checksum
How to use checksums
d56fa8f273640845d54a97ce493c7f274dca3e5717f36387f5a17ae004441674
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-macosx_11_0_arm64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-macosx_11_0_arm64.whl
Size 332.8 kB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
1354f8a9ff817df0c232862b6e8535a5de24cd2614f56aa599f7ff180bca35b7
BLAKE2b-256 checksum
How to use checksums
ced1f82680e49dfc690a0230cc93e6adb41ac65cd60213f3f999827cb78bc428
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / jenkinsfilelint_engine-0.3.0-py3-none-macosx_10_12_x86_64.whl

Download URL jenkinsfilelint_engine-0.3.0-py3-none-macosx_10_12_x86_64.whl
Size 357.6 kB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
99ae974e8522c47f25208590d28cacc2aed4d211ac2a3d00e4dd3e2832a688c6
BLAKE2b-256 checksum
How to use checksums
14198d9bee8da8cec95ec734d69f590182daf1483d1ea420858b68865441dfd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for jenkinsfilelint-engine 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 13 files in this release have been uploaded with provenance metadata.

Select from 13 files

Attestation for jenkinsfilelint_engine-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page