Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/python-jsonschema/check-jsonschema
A CLI and set of pre-commit hooks for jsonschema validation with built-in support for GitHub Workflows, Renovate, Azure Pipelines, and more!
https://github.com/python-jsonschema/check-jsonschema
cli json-schema pre-commit python
Last synced: 4 days ago
JSON representation
A CLI and set of pre-commit hooks for jsonschema validation with built-in support for GitHub Workflows, Renovate, Azure Pipelines, and more!
- Host: GitHub
- URL: https://github.com/python-jsonschema/check-jsonschema
- Owner: python-jsonschema
- License: other
- Created: 2021-01-08T05:35:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T21:34:13.000Z (15 days ago)
- Last Synced: 2025-02-07T22:03:59.319Z (11 days ago)
- Topics: cli, json-schema, pre-commit, python
- Language: Python
- Homepage: https://check-jsonschema.readthedocs.io/en/stable
- Size: 1.77 MB
- Stars: 233
- Watchers: 7
- Forks: 42
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/check-jsonschema/)
[](https://pypi.org/project/check-jsonschema/)
[](https://github.com/python-jsonschema/check-jsonschema/actions/workflows/build.yaml)
[](https://results.pre-commit.ci/latest/github/python-jsonschema/check-jsonschema/main)
[](https://check-jsonschema.readthedocs.io/en/stable)# check-jsonschema
A JSON Schema CLI and [pre-commit](https://pre-commit.com/) hook built on [jsonschema](https://github.com/python-jsonschema/jsonschema/).
The schema may be specified as a local or remote (HTTP or HTTPS) file.Remote files are automatically downloaded and cached if possible.
## Usage
`check-jsonschema` can be installed and run as a CLI tool, or via pre-commit.
### Example pre-commit config
The following configuration uses `check-jsonschema` to validate Github Workflow
files.```yaml
- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.31.1
hooks:
- id: check-github-workflows
args: ["--verbose"]
```### Installing and Running as a CLI Tool
Install with `pipx` or `brew`:
pipx install check-jsonschema
or
brew install check-jsonschema
Then run, as in
check-jsonschema --schemafile schema.json instance.json
## Documentation
Full documentation can be found at https://check-jsonschema.readthedocs.io/