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.1

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

Built distributions (wheels)

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

Total release size: 3.3 MB

Release files / jenkinsfilelint_engine-0.1.1.tar.gz

Download URL jenkinsfilelint_engine-0.1.1.tar.gz
Size 59.6 kB
Tags Source
SHA-256 checksum
How to use checksums
91a613ceafefac0ceff0c1c7101f5663d81cb9b1cb606e9ef27e040f2ec8079d
BLAKE2b-256 checksum
How to use checksums
feb5c446d264d31b14f414c4f002749f5ffb0cffb0dd2a6b3a0fecf8a309886a
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.1-py3-none-win_amd64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-win_amd64.whl
Size 189.7 kB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
60d72a513f9fe24c82818d06a9d9fbb18b2cf67eeaaf8fcd1aede3e042b49105
BLAKE2b-256 checksum
How to use checksums
f18220bb929602965a58a4f58fd58c6d86c51a867ab4e1b4a4a354dac5372252
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.1-py3-none-win32.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-win32.whl
Size 179.3 kB
Tags Python 3 Windows x86-32
SHA-256 checksum
How to use checksums
08710134c5a79c8e1f5326eecf7ba216dc215b6b62dd9ef7742a1fc32affff57
BLAKE2b-256 checksum
How to use checksums
711c5a40b3980954370a686cb2ec717b274fcf63b4cc1b3d97c15e03d801abd9
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.1-py3-none-musllinux_1_2_x86_64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-musllinux_1_2_x86_64.whl
Size 323.9 kB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
5c30bbd536089aa255ea9f4fb12b922a47fddd898773392d57d91cf2bb04f558
BLAKE2b-256 checksum
How to use checksums
7fbcd54de04ab56efd3c3a21d6fc5ab6d13afce8a2aa4aeb1f2ea87c2fa974a6
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.1-py3-none-musllinux_1_2_i686.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-musllinux_1_2_i686.whl
Size 333.4 kB
Tags Linux musl 1.2+ x86-32 Python 3
SHA-256 checksum
How to use checksums
1c946c23e9173d417595f8abb7f4f6833fbf7e285ec71f680afb814d9fa0b891
BLAKE2b-256 checksum
How to use checksums
016da56b9200b3d0bcf21ec6c59c97da35df91504a73b4ef4d58b4031af1f77d
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.1-py3-none-musllinux_1_2_armv7l.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-musllinux_1_2_armv7l.whl
Size 297.1 kB
Tags Linux musl 1.2+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
8e7460a2ae3188a6b328a6555541fe57967e8582a764dfe24359bb20a72f19b6
BLAKE2b-256 checksum
How to use checksums
f357043cdda40fe6d30482ea0f117eab9fb5cb03e35d02c5ecddb0b845e8d445
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.1-py3-none-musllinux_1_2_aarch64.whl

Download URL jenkinsfilelint_engine-0.1.1-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
2dbce98f31556d98710dafc46dd3f28feacb1f25b5292f90ca65be22c1a8f6a0
BLAKE2b-256 checksum
How to use checksums
284fd317beecf35ed3cf6397ef0bc87581565fcf896f424eb87c79564aa1c4a1
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.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 270.9 kB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
53f3b16c762d9847b0d91e55f82d03b184b88120bebbd686769c370a34956348
BLAKE2b-256 checksum
How to use checksums
43e1e555b0224284825b3bd329b734026643bd8ef185eb239f3c4f5ed424874c
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.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Size 289.3 kB
Tags Linux glibc 2.17+ x86-32 Python 3
SHA-256 checksum
How to use checksums
75b9ac776d503ec8a1b4c901fbd93acdd37d73eb5ddd0a7943a72d8c9aeff603
BLAKE2b-256 checksum
How to use checksums
a0a1454ea9505086014f98a7b99709d20e84b4351a44e7f1de654a63dc833b14
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.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Size 268.1 kB
Tags Linux glibc 2.17+ ARMv7l Python 3
SHA-256 checksum
How to use checksums
4ea0345d484868d68a1e2eca7950ecbcabd81e4981eda2ab6b2fe5f5348c3a3e
BLAKE2b-256 checksum
How to use checksums
f74f0548e68d3fe5336bb7e707494f545d14723ecaf9a08353aca18adb0da52c
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.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 260.3 kB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
ca18c8c330179bd27204f5e82cb43815cbc032340d7de931f28738b637e7aee7
BLAKE2b-256 checksum
How to use checksums
2c911656e2ac191cd71931915c646eda2fcc129579914bab82341d8a610e9819
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.1-py3-none-macosx_11_0_arm64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-macosx_11_0_arm64.whl
Size 247.0 kB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
ec565852c9145c7716b1d08541fa6304cc5d9bbacf21e3e4893a9ea868905c50
BLAKE2b-256 checksum
How to use checksums
88d3d735b90316d24b7256730e121195268afcff51705f98458a426afdbc035e
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.1-py3-none-macosx_10_12_x86_64.whl

Download URL jenkinsfilelint_engine-0.1.1-py3-none-macosx_10_12_x86_64.whl
Size 264.9 kB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
d0093e56667284d7b242a74292ebee573488713feace13368384185bf9e2d33f
BLAKE2b-256 checksum
How to use checksums
9a66dc2f2aeda5d6e55c8b0fefe4968299d05aff3e2f7fb50da662ce139cb130
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.1

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.1.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