Commands
Reference for all Pinarkive CLI commands. Use PINARKIVE_API_KEY in the environment.
upload
Upload a file to Pinarkive.
npx pinarkive upload file.pngpinarkive upload path/to/document.pdfThe file is sent to POST https://api.pinarkive.com/v3/files. The CLI prints the returned CID and gateway URL.
pin
Pin an existing IPFS content by CID.
pinarkive pin <cid>Example:
pinarkive pin bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdiCalls POST https://api.pinarkive.com/v3/files/pin/:cid.
list
List your uploads (paginated).
pinarkive listCalls GET https://api.pinarkive.com/v3/users/me/uploads.
delete
Remove a pin by CID.
pinarkive delete <cid>Example:
pinarkive delete bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdiCalls DELETE https://api.pinarkive.com/v3/files/remove/:cid.
Summary
| Command | Description | API endpoint |
|---|---|---|
pinarkive upload <file> | Upload a file | POST /v3/files |
pinarkive pin <cid> | Pin by CID | POST /v3/files/pin/:cid |
pinarkive list | List uploads | GET /v3/users/me/uploads |
pinarkive delete <cid> | Remove pin | DELETE /v3/files/remove/:cid |
For the latest options and flags, run:
npx pinarkive --help