Skip to content

docs: add cargo install option and update CLI output #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felippemsc merged 1 commit into from
Feb 8, 2026
Merged

docs: add cargo install option and update CLI output #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions docs/guides/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,25 @@ Get up and running with SignedShot in 5 minutes. This guide shows you how to ver

## Prerequisites

- Python 3.12+
- Python 3.12+ or Rust toolchain
- A media file with its sidecar (e.g., `photo.jpg` and `photo.sidecar.json`)

Don't have test files? Use the [interactive demo](https://signedshot.io/demo) to capture media and download both files.

## Install the Library
## Install

### Python (recommended)

```bash
pip install signedshot
```

### Rust

```bash
cargo install signedshot-validator
```

## Verify Media

```python
Expand Down Expand Up @@ -77,7 +85,7 @@ result = signedshot.validate(sidecar_json, media_bytes)

## CLI Usage

The library also installs a command-line tool:
Both installation methods include the `signedshot` command-line tool:

```bash
# Basic validation
Expand All @@ -94,18 +102,29 @@ Validating sidecar: photo.sidecar.json
Media file: photo.jpg
[OK] Sidecar parsed
[OK] JWT decoded
Issuer: https://api.signedshot.io
Publisher: 9a5b1062-a8fe-4871-bdc1-fe54e96cbf1c
Device: ea5c9bfe-6bbc-4ee2-b82d-0bcfcc185ef1
Capture: ac85dbd2-d8a8-4d0b-9e39-2feef5f7b19f
Method: app_check
App ID: io.signedshot.capture
[..] Fetching JWKS from https://api.signedshot.io
[OK] JWT signature verified
[OK] Content hash matches
[OK] Content hash verified
[OK] Media signature verified
[OK] Capture IDs match

✓ VALID - Media authenticity verified
[OK] Capture ID match verified

Claims:
Issuer: https://api.signedshot.io
Capture ID: ac85dbd2-d8a8-4d0b-9e39-2feef5f7b19f
Publisher ID: 9a5b1062-a8fe-4871-bdc1-fe54e96cbf1c
Device ID: ea5c9bfe-6bbc-4ee2-b82d-0bcfcc185ef1
Method: app_check
App ID: io.signedshot.capture
Issued At: 1770319379
Key ID: 2ad290db...

Media Integrity:
Content Hash: a4d14b8e32df4123aa91ee172257856456d90f52...
Capture ID: ac85dbd2-d8a8-4d0b-9e39-2feef5f7b19f
Captured At: 2026-02-05T19:22:58Z
Public Key: BDX7zNtobXIurJGN5XQFNISR/SLP1u/hhlKng/gW...

[OK] Validation complete
```

## What Gets Validated
Expand Down
5 changes: 3 additions & 2 deletions docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,11 @@ let sidecar = try await signedShot.createSidecar(imageData: jpegData, session: s

### Verify media

Use the Python library to verify any SignedShot capture.
Use the Python library or Rust CLI to verify any SignedShot capture.

```bash
pip install signedshot
pip install signedshot # Python
cargo install signedshot-validator # or Rust
```

```python
Expand Down