This page is auto-generated. Do not edit directly. To update, modify the CLI source in pinner-cli and run
pnpm generate:clil.
pin
pinner pin <cid...> [flags]Shortcut for 'pinner pins add'. Pin existing IPFS content by CID. Multiple CIDs can be provided as arguments, read from a file using --file, or piped from stdin.
pinner pin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner pin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --name "my file"
pinner pin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --no-wait
pinner pin bafybeig...abc bafybeig...def bafybeig...ghi --parallel 5
pinner pin --file cids.txt
echo "bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e" | pinner pin
pinner pin --file cids.txt --continue --parallel 10
pinner pin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --dry-run| Flag | Alias | Description |
|---|---|---|
--name | Custom name for the pin | |
--no-wait | Return immediately without waiting for pinning to complete | |
--file | Read CIDs from a file (one per line) | |
--parallel | Number of parallel operations (default: 1) | |
--continue | Continue processing even if some operations fail | |
--dry-run | Preview operations without making any changes |
pins
pinner pinsManage your pinned IPFS content with subcommands for adding, removing, listing, checking status, and updating pin metadata.
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --name "my file"
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --meta owner=alice --meta env=prod
pinner pins rm bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --force
pinner pins ls --status pinned
pinner pins status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --meta owner=bobSubcommands:
| Subcommand | Description |
|---|---|
add | Pin content that is already on IPFS by providing its CID. Optionally set metadata key-value pairs at pin time using --meta. |
rm | Remove a pin by its CID, or remove all pins with --all. |
ls | List your pinned content with optional filtering. |
status | Check whether a pin has completed. If the pin is not found, account operations are checked as a fallback. |
update | Update name and/or metadata for a pin. Metadata is a set of key-value pairs (e.g., owner=alice, env=prod) that help you organize and filter pins. |
add
pinner pins add <cid...> [flags]Pin content that is already on IPFS by providing its CID. Optionally set metadata key-value pairs at pin time using --meta.
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --name "my file"
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --no-wait
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --meta owner=alice --meta env=prod
pinner pins add bafybeig...abc bafybeig...def bafybeig...ghi --parallel 5
pinner pins add --file cids.txt
pinner pins add bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --dry-run| Flag | Alias | Description |
|---|---|---|
--name | Custom name for the pin | |
--no-wait | Return immediately without waiting for pinning to complete | |
--file | Read CIDs from a file (one per line) | |
--parallel | Number of parallel operations (default: 1) | |
--continue | Continue processing even if some operations fail | |
--dry-run | Preview operations without making any changes | |
--meta | Set metadata as key=value (repeatable) |
rm
pinner pins rm <cid...> [flags]Remove a pin by its CID, or remove all pins with --all.
pinner pins rm bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner pins rm bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --force
pinner pins rm bafybeig...abc bafybeig...def bafybeig...ghi --force
pinner pins rm --file cids.txt --force
pinner pins rm bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --dry-run
pinner pins rm --all --force
pinner pins rm --all --status failed --force| Flag | Alias | Description |
|---|---|---|
--force | Force operation without confirmation | |
--file | Read CIDs from a file (one per line) | |
--parallel | Number of parallel operations (default: 1) | |
--continue | Continue processing even if some operations fail | |
--dry-run | Preview operations without making any changes | |
--status | Filter by pin status (queued, pinning, pinned, failed) | |
--all | Remove all pins (requires --force) |
ls
pinner pins ls [flags]List your pinned content with optional filtering.
pinner pins ls
pinner pins ls --name "my-project"
pinner pins ls --status pinned
pinner pins ls --limit 20
pinner pins ls --watch| Flag | Alias | Description |
|---|---|---|
--name | Filter by name | |
--limit | Maximum number of results to return | |
--status | Filter by pin status (queued, pinning, pinned, failed) | |
--watch | Continuously monitor and update pin status (useful for watching uploads) |
status
pinner pins status <cid> [flags]Check whether a pin has completed. If the pin is not found, account operations are checked as a fallback.
pinner pins status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner pins status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --watch
pinner pins status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --json| Flag | Alias | Description |
|---|---|---|
--watch | Poll until settled |
update
pinner pins update <cid> [flags]Update name and/or metadata for a pin. Metadata is a set of key-value pairs (e.g., owner=alice, env=prod) that help you organize and filter pins.
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --name "renamed"
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --meta owner=alice --meta env=prod
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --clear-meta
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --clear-meta --meta fresh=start
pinner pins update bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --name "renamed" --meta env=prod| Flag | Alias | Description |
|---|---|---|
--name | Rename the pin | |
--meta | Set metadata as key=value (repeatable) | |
--clear-meta | Clear all metadata | |
--dry-run | Preview operations without making any changes |
list
pinner list [flags]Shortcut for 'pinner pins ls'. List your pinned content with optional filtering.
pinner list
pinner list --name "my-project"
pinner list --status pinned
pinner list --limit 20
pinner list --watch
pinner list --name backup --status failed --limit 50
echo "backup" | pinner list| Flag | Alias | Description |
|---|---|---|
--name | Filter by name | |
--limit | Maximum number of results to return | |
--status | Filter by pin status (queued, pinning, pinned, failed) | |
--watch | Continuously monitor and update pin status (useful for watching uploads) |
status
pinner status <cid> [flags]Shortcut for 'pinner pins status'. Check whether a pin has completed. If the pin is not found, account operations are checked as a fallback.
pinner status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --watch
pinner status bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --json
echo "bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e" | pinner status
cat cids.txt | pinner status
Status values:
queued- Pin is queued for processing
pinning
- Pin is being processed
pinned
- Pin is successfully pinned
failed
- Pin failed to pin
Operation status values (shown when pin is not found):
pending
- Operation is queued
running
- Operation is in progress
completed - Operation finished successfully
failed
- Operation failed
error
- Operation encountered an error
| Flag | Alias | Description |
|---|---|---|
--watch | Poll until settled |
unpin
pinner unpin <cid...> [flags]Shortcut for 'pinner pins rm'. Remove pins by CID or remove all pins.
pinner unpin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
pinner unpin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --force
pinner unpin bafybeig...abc bafybeig...def bafybeig...ghi --force
pinner unpin --file cids.txt --force
pinner unpin --file cids.txt --force --parallel 5 --continue
pinner unpin bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --dry-run
pinner unpin all --force
pinner unpin all --force --status failed --dry-run| Flag | Alias | Description |
|---|---|---|
--force | Force operation without confirmation | |
--file | Read CIDs from a file (one per line) | |
--parallel | Number of parallel operations (default: 1) | |
--continue | Continue processing even if some operations fail | |
--dry-run | Preview operations without making any changes |
Subcommands:
| Subcommand | Description |
|---|---|
all | Remove all pinned content. This is a destructive operation with safety guards. |
all
pinner unpin all [flags]Remove all pinned content. This is a destructive operation with safety guards.
This command requires two explicit confirmations: 1. The --force flag to acknowledge the destructive nature 2. An interactive prompt requiring you to type the exact number of pins
For non-interactive use (scripts, CI), use --yes to accept the safety prompt. --force is always required regardless of --yes.
pinner unpin all --force
pinner unpin all --force --status failed
pinner unpin all --force --parallel 5 --continue
pinner unpin all --force --dry-run
pinner unpin all --force --yes
pinner unpin all --force --status queued --dry-run| Flag | Alias | Description |
|---|---|---|
--force | Force operation without confirmation | |
--status | Filter by pin status (queued, pinning, pinned, failed) | |
--parallel | Number of parallel operations (default: 1) | |
--continue | Continue processing even if some operations fail | |
--dry-run | Preview operations without making any changes |
metadata
pinner metadataThe 'metadata' command has been removed. Use 'pinner pins update' to update pin metadata instead