Metadata-Version: 2.4
Name: actionlint-kjanat
Version: 1.17.1
Summary: Static checker for GitHub Actions workflow files
Keywords: actionlint,github-actions,workflow,linter,lint,static-analysis,cli,yaml,shellcheck
Author-email: Kaj Kowalski <info+actionlint@kajkowalski.nl>
License-Expression: MIT
License-File: LICENSE.txt
Project-URL: Homepage, https://actionlint.kjanat.dev
Project-URL: Documentation, https://github.com/kjanat/actionlint/tree/v1.17.1/docs
Project-URL: Repository, https://github.com/kjanat/actionlint
Project-URL: Issues, https://github.com/kjanat/actionlint/issues
Project-URL: Funding, https://github.com/sponsors/kjanat
Description-Content-Type: text/markdown

# actionlint

[actionlint](https://github.com/kjanat/actionlint) checks GitHub Actions workflows
for YAML errors, invalid expressions, incorrect action inputs and unsafe script
interpolation.

## Install

```sh
python -m pip install actionlint-kjanat
```

The package installs the `actionlint` command. pip selects the executable for your
operating system and CPU. You do not need Go or a compiler.

With uv, add actionlint as a development dependency and run it in the project:

```sh
uv add --dev actionlint-kjanat
uv run actionlint
```

To run it without adding a dependency:

```sh
uvx --from actionlint-kjanat actionlint
```

`--from` selects the PyPI package, whose command is named `actionlint`.

## Check your workflows

Run actionlint from your Git repository:

```sh
actionlint
```

To check a specific file:

```sh
actionlint .github/workflows/ci.yml
```

Use `actionlint -h` for command options. See the
[usage guide](https://github.com/kjanat/actionlint/blob/v1.17.1/docs/usage.md)
for configuration and the
[checks list](https://github.com/kjanat/actionlint/blob/v1.17.1/docs/checks.md)
for examples. To check embedded shell and Python scripts, follow the script-linter
setup instructions in the usage guide.

## Supported platforms

Wheels are available for Linux with glibc or musl, macOS and Windows. Each wheel
includes the executable from the
[v1.17.1 release](https://github.com/kjanat/actionlint/releases/tag/v1.17.1).
If pip cannot find a wheel for your platform, use an archive from that release.

## Support development

[Sponsor Kaj Kowalski](https://github.com/sponsors/kjanat) to support actionlint
development. Report problems in the
[issue tracker](https://github.com/kjanat/actionlint/issues).
