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 Upload

Upload files and directories to IPFS via the Pinner.xyz service.

upload command

pinner upload <path>

Upload a File

pinner upload document.txt

Upload with Name

pinner upload document.txt --name "My Document"

Upload and Wait

pinner upload document.txt --wait

Blocks until the pinning operation completes.

Upload a Directory

pinner upload ./my-directory --name "My Project"

Upload from Stdin

# Pipe content
cat myfile.txt | pinner upload --name "my file"
 
# Echo content
echo "hello world" | pinner upload --name "greeting"
 
# Download and upload
curl -s https://example.com/data | pinner upload --name "downloaded"

Large File Options

# Set memory limit for CAR generation (in MB)
pinner upload largefile.zip --memory-limit 500 --wait
 
# Preview without uploading
pinner upload file.txt --dry-run

Options

OptionDescription
--nameCustom name for the pin
--waitWait for pinning to complete
--memory-limitMemory limit for CAR generation in MB (env: PINNER_MEMORY_LIMIT)
--dry-runPreview operation without uploading

Output

The upload command returns:

  • CID: Content identifier for your uploaded content
  • Gateway URL: Public URL to access your content
  • Size: File size in human-readable format
  • Time: Upload duration
Uploaded CID: bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq
Gateway URL: https://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq.ipfs.dweb.link
Size: 1.5 MB
Time: 2.345s