OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Storage & Data Availability

W3Up

W3Up is a JavaScript implementation of the web3.storage UCAN protocol that underpins web3.storage server and client components. Its documented tools upload files through a browser, CLI, JavaScript client or GitHub Action, calculate root IPFS CIDs, and support retrieval through IPFS gateways. The repository is deprecated and directs users to storacha/upload-service.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

W3Up — OpenViST project profile in Storage & Data Availability.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use the documented workflows when you need to upload files to web3.storage and work with their IPFS CIDs. For new development, account for the repository's deprecation notice and its direction to storacha/upload-service.

Who it is for

  • People uploading files through the web3.storage browser interface.
  • Developers who need CLI or JavaScript-client uploads and CID-based retrieval.
  • Teams publishing build artifacts to web3.storage from GitHub Actions.

Documented uses

  • Upload a local file or directory to web3.storage.
  • Integrate file or directory uploads into a JavaScript application.
  • Publish a build output directory from a GitHub Actions workflow.
  • Retrieve uploaded content through an IPFS gateway using its root CID.
Before you choose

Requirements & limits

  • The repository implements the web3.storage UCAN protocol and is described as core to server and client implementations.
  • The README describes local content hashing and root CID calculation before upload; its browser flow performs chunking and hashing in the browser.
  • The available paths differ by task: browser console, CLI, JavaScript client, or GitHub Action.
  • The repository is deprecated and directs users to storacha/upload-service, limiting its stated role to backporting changes to @web3-storage/* modules.
  • The repository's contribution notes specify Node.js 18 and pnpm workspaces.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Upload a local file with the W3Up CLI

Authorize the CLI, create a Space, and upload a local file to receive its IPFS CID and gateway URL.

Before you start

  • Install the @web3-storage/w3cli package globally.
  • Use an email address to log in and sync existing UCAN delegations.

Steps

  1. Run w3 login with your email address.

  2. Create a Space with w3 space create and a name such as Documents.

  3. Run w3 up with the path to the file.

Expected outcome

The README shows the CLI reporting a stored file and a gateway URL containing its root CID.

Guide limitations

  • The repository is deprecated and directs users to storacha/upload-service; it says to use this repository only for backporting changes to @web3-storage/* modules.
  • The documented login step refers to syncing existing UCAN delegations.
Documentation 1 ↗
Source-based practical guide

Publish a build directory with the documented GitHub Action

Pass a build output directory to the add-to-web3 Action and expose the resulting CID and URL in a workflow.

Before you start

  • A build step that produces the directory to upload.
  • A secret key and delegated proof configured as GitHub secrets; the README links to instructions for generating these credentials.

Steps

  1. Build the project and produce an output directory such as ./dist.

  2. Add the web3-storage/add-to-web3@v3.0.0 Action with path_to_add set to the build directory and its secret_key and proof inputs set to the corresponding secrets.

  3. Read the Action's cid and url outputs in subsequent workflow steps.

Expected outcome

The workflow can use the uploaded content's CID and gateway URL as Action outputs.

Guide limitations

  • The README documents the workflow configuration but does not provide a full credential-generation procedure in this repository.
  • The repository is deprecated and directs users to storacha/upload-service; it says to use this repository only for backporting changes to @web3-storage/* modules.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
17 October 2026
Original website title
storacha/w3up · Official homepage title · retained in its source language
How we review sourcesSuggest a correction