We just announced the launch of our new w3up upload API, our new content upload and storage platform that combines the power of content addressing and user-controlled identity with the scalability of the modern cloud.

This post maps the resources you need to get started, highlighting the examples, tools, APIs, and presentation materials we've built to unlock the data layer. Let's dive in!

w3up-cli for the command line

Whether you live in the terminal or just like to visit from time to time, the w3up-cli tool is here for you.

Using the w3up command, you can create a new UCAN identity and register for access to the w3up service, upload files, and manage your uploaded data.

Check out our introduction to using w3up from the command line for an overview, or dive into the README for more details.

If you're more of a hands-on learner, just install the w3up command with NPM:

npm install -g @web3-storage/w3up-cli

Now you can run w3up with no arguments to see the help text and a "quickstart" guide for signing up and making your first upload.

w3up-client for JavaScript

The w3up command line tool is built in JavaScript using a library called w3up-client.

You can use the same library in your own JavaScript and TypeScript projects to interact with the w3up service from node.js. The library is also reused in our UI toolkit for web browsers and mobile apps. The client library provides all the functionality of the w3up command line tool, including identity creation and registration, uploading files, and managing your completed uploads.

To get a feel for working with w3up-client, check our introductory post, which walks through some snippets of our simple-upload example project, a simplified and heavily-commented command line upload tool for node.js.

w3ui for web and mobile applications

If you're building for the web or mobile devices, we've been working on something special just for you.

The w3ui project makes it simple to add w3up to your favorite frontend UI frameworks, including React, Solid, and Vue, with React Native support for mobile devices coming soon.

We're able to cover so many different frameworks by building a set of "headless" core modules, each providing a piece of key functionality in a framework-agnostic manner. We then build out components for each supported framework that adapts the core modules to the idioms and practices of each framework.

We want you to be able to dive in and start building, so we've made a collection of example apps for each framework that demonstrates how to use the core components.

Check out the w3ui examples for a collection of self-contained example apps that you can use as a starting point for your own projects.


Dev advocates: please share the story of w3up and web3.storage by giving talks, hosting Twitter spaces, writing blogs etc. You can use this Google Sheets workshop presentation as source material, or present it yourself. We'd love to know how it goes!

Get in touch with the team

If you need help using w3up or have suggestions to make it better, please get in touch! We need your help making w3up realize its full potential, and we also love hearing from people building on our tech. We can't wait to see what you'll build!