Store a directory of files

You can use NFT.Storage to store any files needed for your NFT projects. This guide shows a simple example of uploading a directory full of files using a script written in Node.js with the nft.storage JavaScript client library.

To follow along, you'll need Node.js version 16 or greater.

Creating a project#

Create a new directory and use npm to initalize a new JavaScript project.

mkdir store-directory
cd store-directory
npm init -y

This will create a package.json file with the standard "new project" defaults.

Next, add the nft.storage and files-from-path packages to your project's dependencies:

npm install nft.storage files-from-path

Adding the upload code#

Create a file called storeDirectory.mjs and add the following code:

import { NFTStorage, File } from 'nft.storage'
import { getFilesFromPath } from 'files-from-path'

const token = 'YOUR_API_TOKEN'

async function main() {
  const path = process.argv.slice(2)
  const files = await getFilesFromPath(path)

  const storage = new NFTStorage({ token })

  console.log(`storing ${files.length} file(s) from ${path}`)
  const cid = await storage.storeDirectory(files, {
      hidden: true // use the default of false if you want to ignore files that start with '.'
  })
  console.log({ cid })

  const status = await storage.status(cid)
  console.log(status)
}
main()

You'll need to replace YOUR_API_TOKEN with your NFT.Storage API key. If you don't yet have an API key, see the Quickstart guide.

Running the script#

You should now be able to run the script and pass in the path to a directory:

node storeDirectory.mjs 'path_to_your_directory'

When the upload is complete, the CID and status of the upload will be printed to the console.