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
agentandstages; allowed and duplicate sections; each stage has exactly one ofsteps,stages,parallelormatrix; no nestedparallel/matrix;agentforms and built-in agent parameters;environmentkeys and values;options,triggers,parameters,tools,libraries,input;whenconditions and their nesting;postconditions;matrixaxes and excludes; steps that are blocked in Declarative (stage,properties, mixedparallel);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.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jenkinsfilelint_engine-0.2.0.tar.gz | 116.5 kB | With provenance | Details for jenkinsfilelint_engine-0.2.0.tar.gz |
Built distributions (wheels)
Total release size: 4.4 MB
Release files / jenkinsfilelint_engine-0.2.0.tar.gz
| Download URL | jenkinsfilelint_engine-0.2.0.tar.gz |
|---|---|
| Size | 116.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c7894414d466129d3cb2d5488b27205e6315080f59a191c644b7a83fe3e840ee
|
|
BLAKE2b-256 checksum How to use checksums |
181c3707afa53110573399b8211912b80fa7ac49244f2d74a9a4f1bb29a1cc31
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-win_amd64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-win_amd64.whl |
|---|---|
| Size | 287.1 kB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
4ed04cc4ceb6674901d2357112528ae2db77905c3d9e2396594076fe8ae9207e
|
|
BLAKE2b-256 checksum How to use checksums |
34eeb8e4573145b8d603a2416f072316f019f07dfa5ec242f9737115b5ff91f8
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-win32.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-win32.whl |
|---|---|
| Size | 266.2 kB |
| Tags | Python 3 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
0697c94bba96abb6fcedb38127759069646abf45699bf265c92b27f554926593
|
|
BLAKE2b-256 checksum How to use checksums |
55b6037d7bdc7e2fac34cf15dde3f3179328dca73a27250d109c3abb7b372b68
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_x86_64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 420.6 kB |
| Tags | Linux musl 1.2+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
3f6b8eb1996c1d58e415715f406554f8c2ece76d62e60dc3f41aa82d1316cad2
|
|
BLAKE2b-256 checksum How to use checksums |
8e1d6a13923c2a8074047cbd9286d81fe22fdcf5ac2b5afc2ccccf192a00066b
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_i686.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_i686.whl |
|---|---|
| Size | 425.0 kB |
| Tags | Linux musl 1.2+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
a89996fa89be4cd3315e2c4b3a9e277d3a6f201f5de00e970b58d1766580f291
|
|
BLAKE2b-256 checksum How to use checksums |
a0541c97cb87810e58ed762ca824a84d71be5169630e3a87fd4262c03469ccc9
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_armv7l.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_armv7l.whl |
|---|---|
| Size | 382.3 kB |
| Tags | Linux musl 1.2+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
489e938e7befabe62c63a37488a9a20c6cf02f6beeeae4aa3c7d624b494bc098
|
|
BLAKE2b-256 checksum How to use checksums |
10ba80c09383c5779aae6c4508891531a3427088587b7b7d1f326779a9ecb19d
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_aarch64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 397.5 kB |
| Tags | Linux musl 1.2+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
10598e6cdaaf605222f1f89c0a9bbe1e938c58e46b44dfc2fc269986e2bb3d95
|
|
BLAKE2b-256 checksum How to use checksums |
e25173e4709cb7caf0cd1e28091384b927329aece37314368b5b5875fe587596
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 367.7 kB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
68a2fbcf14be6113b0279446da039e733c033c1042ccf32e93d7193b1f6e6709
|
|
BLAKE2b-256 checksum How to use checksums |
49697e4c86a1d2d65f8854271fc6f5ce713665d0d24fe99762b5d881e746a9a8
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 382.9 kB |
| Tags | Linux glibc 2.17+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
7d87c30850becef6442233a7948cb69cfdb8651c559f57e102567eafdbacdf33
|
|
BLAKE2b-256 checksum How to use checksums |
c4a2f8a414e47fc02ff8c8ff3b287c6eea00f2b1c6f66b36d11543377c1ef5cd
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl |
|---|---|
| Size | 354.4 kB |
| Tags | Linux glibc 2.17+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
01b5a22d60564cfe1bdceefd7a9b748f858407725a8df0023b74539c2fe1616c
|
|
BLAKE2b-256 checksum How to use checksums |
4fd0c88d4a6884957bd254760cac71e5a641282d8b67869b9cb48100c4eaa78f
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 350.1 kB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
635bbce61833c0dfe09f391e0119f5c7aefc430f7988f8d88853484cffc353e9
|
|
BLAKE2b-256 checksum How to use checksums |
7f091574c218b7f6d4fb4e10ccec03b005cf872937be92416814baed013ffa61
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-macosx_11_0_arm64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 331.9 kB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
cef2258618acff3236accc8ae45ed9a93fd34d50d76a2f2e42737aff6d154e3b
|
|
BLAKE2b-256 checksum How to use checksums |
20e35bdc66d22bf6771dcd8c5e3796de5a5e4db4d29233e6f2f98b9bb4c6c176
|
| 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 logRelease files / jenkinsfilelint_engine-0.2.0-py3-none-macosx_10_12_x86_64.whl
| Download URL | jenkinsfilelint_engine-0.2.0-py3-none-macosx_10_12_x86_64.whl |
|---|---|
| Size | 356.9 kB |
| Tags | Python 3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
36483800d3496d380a2ad6fa4676283be15340bc9b268653f8a805c9a17a72a2
|
|
BLAKE2b-256 checksum How to use checksums |
bbfb23a5328c37377f72f99933360cf0b7757b0101f2664b5dc9de255e0b2eab
|
| 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 logSecurity for jenkinsfilelint-engine 0.2.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.
Attestation for jenkinsfilelint_engine-0.2.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 logA 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.