1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
[](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.34.0
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/
|
