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.1.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.1.0
File Size Uploaded Provenance Actions
jenkinsfilelint_engine-0.1.0.tar.gz 59.2 kB With provenance Details for jenkinsfilelint_engine-0.1.0.tar.gz

Built distributions (wheels)

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

Total release size: 3.3 MB

Release files / jenkinsfilelint_engine-0.1.0.tar.gz

Download URL jenkinsfilelint_engine-0.1.0.tar.gz
Size 59.2 kB
Tags Source
SHA-256 checksum
How to use checksums
08eaf11dd49b13c87a87b5eba9091a44b851e15670ea771c0485809b28135966
BLAKE2b-256 checksum
How to use checksums
e827ce9972109f19ef5db985e26a29a0639fa42b3124d6f412ae0732f695bd2a
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-win_amd64.whl
Size 189.4 kB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
99c460c41b22383a2d49d2c851c198acb04156e9a4994ba388d00dd698a348e7
BLAKE2b-256 checksum
How to use checksums
2cab54bc6beca01498d0125e359afb05183c99467086aafc41cc20bd55a16317
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-win32.whl
Size 179.1 kB
Tags Python 3 Windows x86-32
SHA-256 checksum
How to use checksums
f0457b4ebebe7aa1bbead1f6ad78e0f0b01dae102fec28a2d237cba40ac3edd4
BLAKE2b-256 checksum
How to use checksums
55cd511d6e1238adf7dc405c85229ee2a0e95fdb80a79473135425294884c00a
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-musllinux_1_2_x86_64.whl
Size 323.8 kB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
16c6197af6681268e9ee2f7bc402137452f3228f6a64012c72ecd091b871eb6c
BLAKE2b-256 checksum
How to use checksums
6b3260274d252136e21bcae9fcb0cce762e40f887dc6828ce67166cea91f79d0
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-musllinux_1_2_i686.whl
Size 333.2 kB
Tags Linux musl 1.2+ x86-32 Python 3
SHA-256 checksum
How to use checksums
b3ce939c1a5c4aac76a58c5c7ffb9b7bf5715797b3c15d870bfd1fc7d7f71aca
BLAKE2b-256 checksum
How to use checksums
69abccee56147a3f82ab0111e6a32380e3c752df90411b34b84c9b0e2a5b61c7
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-musllinux_1_2_armv7l.whl
Size 296.8 kB
Tags Linux musl 1.2+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
ed6267bc4b5934de149068b9533f8bb685d342aeff605f54cf2d9ebaeb222007
BLAKE2b-256 checksum
How to use checksums
0d42ce52fcbfcb38cc069d52f2ea01a980285a9c43cd0cec0c789853436c183f
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-musllinux_1_2_aarch64.whl
Size 308.7 kB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
6c44f2ef7cf8f7bd35dfee364ba11ddbf1462100369bd6b70b797b4b34fb4be9
BLAKE2b-256 checksum
How to use checksums
3274512a37fb3048957ef935bbd4604beec6144147f0a804aa0a4266fb349429
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 270.7 kB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
a12a1ecd8d83b4f210077b64397561f68403bc1d634c1924db424de28de43ef3
BLAKE2b-256 checksum
How to use checksums
8b2ebe4b16f143bdc8f19cbebdd296a07a9c3f4eae368df211d811a6ce46769d
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Size 289.4 kB
Tags Linux glibc 2.17+ x86-32 Python 3
SHA-256 checksum
How to use checksums
6030d550700280b8472f2d6488ba26d13d29f383f72b026ae193c60d7dfa5012
BLAKE2b-256 checksum
How to use checksums
0f30fba6af94de5331e257b03c0ee577430f2d607342a79b9aa8be84678e8e15
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Size 267.9 kB
Tags Linux glibc 2.17+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
9ff3aa24ca3edbcf38e66219738343971fe7c4f32a2a684ebe46ca967895a948
BLAKE2b-256 checksum
How to use checksums
db99cb2c7d7cdda2c79728b8ed161615d4a9c6127ca25c4bfd13d96e38157163
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 260.1 kB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
5537e66f3f12adc19e36a06a3be063dbccf9656f778e19b40c96909afecddc45
BLAKE2b-256 checksum
How to use checksums
9414e448aa79c1d195ab5d487f855e329e7acab67fcfeafb86681c1d99eae6fd
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-macosx_11_0_arm64.whl
Size 246.7 kB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
edeb6b7974daabc497e7c4aca2f3a2711c477f2b3471a03b886cd5b80bb079ec
BLAKE2b-256 checksum
How to use checksums
fa076b11eda356d8b2a415af8a006fefc399fafa1ef667ba9cd1fe90c7534692
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 18, 2026.

Transparency log

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

Download URL jenkinsfilelint_engine-0.1.0-py3-none-macosx_10_12_x86_64.whl
Size 264.8 kB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
aebbacd93858f10f6355d28510124819f3b2d2747a13a15e884e84640019c27f
BLAKE2b-256 checksum
How to use checksums
6ae50a825434eb127438f3c8d7690a33a58c90774ae70fbaf66848bb44983c85
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 18, 2026.

Transparency log

Security for jenkinsfilelint-engine 0.1.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.1.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 18, 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