Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

CLI Pin

Pin existing content by CID.

pin command

pinner pin <cid...>

Pin a CID

pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq

Pin with Name

pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq --name "My Content"

Pin Multiple CIDs

# As arguments
pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
 
# In parallel (default: 1)
pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco --parallel 5
 
# From a file (one CID per line)
pinner pin --file cids.txt
 
# From stdin
echo "bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq" | pinner pin

Pin and Wait

pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq --wait

Continue on Error

# Continue processing even if some pins fail
pinner pin --file cids.txt --continue --parallel 10 --wait

Preview Mode

# Preview without making changes
pinner pin bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq --dry-run

Options

OptionDescription
--nameCustom name for the pin
--waitWait for pinning to complete
--fileRead CIDs from a file (one per line)
--parallelNumber of parallel operations (default: 1)
--continueContinue processing even if some operations fail
--dry-runPreview operation without making changes

Output

For single CID:

Pinned CID: bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq
Request ID: req-123456
Status: pinned

For batch operations:

Batch operation completed in 2.345s
Total: 10 | Succeeded: 9 | Failed: 1 | Skipped: 0
 
Failed operations:
  - QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco: error message here