CLI
Commands

Commands

Reference for all Pinarkive CLI commands. Use PINARKIVE_API_KEY in the environment.

upload

Upload a file to Pinarkive.

npx pinarkive upload file.png
pinarkive upload path/to/document.pdf

The 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 bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi

Calls POST https://api.pinarkive.com/v3/files/pin/:cid.

list

List your uploads (paginated).

pinarkive list

Calls GET https://api.pinarkive.com/v3/users/me/uploads.

delete

Remove a pin by CID.

pinarkive delete <cid>

Example:

pinarkive delete bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi

Calls DELETE https://api.pinarkive.com/v3/files/remove/:cid.

Summary

CommandDescriptionAPI endpoint
pinarkive upload <file>Upload a filePOST /v3/files
pinarkive pin <cid>Pin by CIDPOST /v3/files/pin/:cid
pinarkive listList uploadsGET /v3/users/me/uploads
pinarkive delete <cid>Remove pinDELETE /v3/files/remove/:cid

For the latest options and flags, run:

npx pinarkive --help