Skip to content
Merged
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ pixelvault get img_xyz -o thumb.webp -t "w=400&fmt=webp" # download a transfor

# Delete an image
pixelvault delete img_xyz

# Export everything — all your images as a tar archive (no lock-in)
pixelvault export -o my-images.tar
```

## Agent Integration
Expand Down Expand Up @@ -80,6 +83,7 @@ npx pixelvault-cli upload build-output.png
| `list` | List uploaded images |
| `get <id>` | Get an image's URL/metadata, or download it (optionally transformed) |
| `delete <id>` | Delete an image |
| `export` | Export all project images as a tar archive |
| `whoami` | Show current auth state |
| `config get\|set\|show` | Manage CLI configuration |

Expand Down Expand Up @@ -107,6 +111,22 @@ background removal (`segment=foreground`), effects (`blur`/`saturation`/`rotate`
and watermark (`tile=img_logo.png` — another of your own images). Reserved
characters in values are percent-encoded for you (e.g. `background=#ffaa00`).

### Export Options

```bash
pixelvault export # download all your images to pixelvault-export-<job>.tar
pixelvault export -o backup.tar # choose the output path
pixelvault export --extract # untar into a directory after download (needs `tar`)
pixelvault export --timeout 900 # wait up to 900s for a large export (default 600)
pixelvault export --json # emit the final job JSON (archive path still to stdout)
```

`export` downloads **every image in your project** plus a `manifest.json` (ids,
filenames, storage keys, URLs, metadata) as a single tar archive — the free,
no-lock-in "take your data anywhere" command. It's async: the CLI starts the job,
polls until it's ready, then downloads. The archive path goes to **stdout**,
progress to **stderr**.

### List Options

```bash
Expand Down
Loading