Skip to content

Commit

Permalink
Document filepack verify in readme (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
casey authored Nov 17, 2024
1 parent 0bbc701 commit 364ea2c
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Which will write the manifest to `path/to/directory/filepack.json`.

Files can later be verified with:

```
```sh
filepack verify path/to/directory
```

Expand Down Expand Up @@ -117,19 +117,43 @@ Create a manifest.

Optional path portability lints can be enabled with:

```
```sh
filepack create --deny all
```

Metadata can optionally be included in the manifest with:

```
```sh
filepack create --metadata <PATH>
```

Where `<PATH>` is a [YAML](https://en.wikipedia.org/wiki/YAML) document
containing metadata with the same schema as that of the manifest.

### `filepack verify`

Verify the contents of a directory against a manifest.

To verify the contents of `DIR` against `DIR/filepack.json`:

```sh
filepack verify DIR
```

If the current directory contains `filepack.json`, `DIR` can be omitted:

```sh
filepack verify
```

`filepack verify` takes an optional `--print` flag, which prints the manifest
to standard output if verification succeeds. This can be used in a pipeline to
ensure that you the manifest has been verified before proceeding:

```sh
filepack verify --print | jq
```

Manifest
--------

Expand Down

0 comments on commit 364ea2c

Please sign in to comment.