Please read the beta Terms of Service for more details.
Open an issue on the repo or reach out to the #web3-storage channel on IPFS Discord if you have any questions!
Install the CLI from npm :
npm install -g @web3-storage/w3cli
Create a new space for storing your data and register it:
w3 space create Documents # pick a good name!
w3 space register alice@example.com
Upload a file or directory:
w3 up recipies.txt
- Basics
- Space management
- Capability management
- Advanced usage
w3 can space info
coming soon!w3 can space recover
coming soon!w3 can store add
w3 can store ls
coming soon!w3 can store rm
coming soon!w3 can upload add
w3 can upload ls
coming soon!w3 can upload rm
coming soon!
Upload file(s) to web3.storage. The IPFS Content ID (CID) for your files is calculated on your machine, and sent up along with your files. web3.storage makes your content available on the IPFS network
--no-wrap
Don't wrap input files with a directory.-H, --hidden
Include paths that start with ".".-c, --car
File is a CAR file.--shard-size
Shard uploads into CAR files of approximately this size in bytes.--concurrent-requests
Send up to this many CAR shards concurrently.
List all the uploads registered in the current space.
--json
Format as newline delimted JSON--shards
Pretty print with shards in output
Remove an upload from the uploads listing. Note that this command does not remove the data from the IPFS network, nor does it remove it from space storage (by default).
--shards
Also remove all shards referenced by the upload from the store. Use with caution and ensure other uploads do not reference the same shards.
Open a CID on https://w3s.link in your browser. You can also pass a CID and a path.
# opens a browser to https://w3s.link/ipfs/bafybeidluj5ub7okodgg5v6l4x3nytpivvcouuxgzuioa6vodg3xt2uqle
w3 open bafybeidluj5ub7okodgg5v6l4x3nytpivvcouuxgzuioa6vodg3xt2uqle
# opens a browser to https://w3s.link/ipfs/bafybeidluj5ub7okodgg5v6l4x3nytpivvcouuxgzuioa6vodg3xt2uqle/olizilla.png
w3 open bafybeidluj5ub7okodgg5v6l4x3nytpivvcouuxgzuioa6vodg3xt2uqle/olizilla.png
Print information about the current agent.
Add a space to the agent. The proof is a CAR encoded delegation to this agent.
Create a new w3 space with an optional name.
List spaces known to the agent.
Claim the space by associating it with your email address.
Set the current space in use by the agent.
Create a delegation to the passed audience for the given abilities with the current space as the resource.
--can
One or more abilities to delegate, default*
(everything).--name
Human readable name for the audience receiving the delegation.--type
Type of the audience receiving the delegation, one of: device, app, service.--output
Path of file to write the exported delegation data to.
List delegations created by this agent for others.
--json
Format as newline delimted JSON
Add a proof delegated to this agent. The proof is a CAR encoded delegation to this agent. Note: you probably want to use w3 space add
unless you know the delegation you received targets a resource other than a w3 space.
List proofs of delegated capabilities. Proofs are delegations with an audience matching the agent DID.
--json
Format as newline delimted JSON
Store a CAR file to web3.storage.
Register an upload - a DAG with the given root data CID that is stored in the given CAR shard(s), identified by CAR CIDs.
Feel free to join in. All welcome. Please read our contributing guidelines and/or open an issue!
Dual-licensed under MIT + Apache 2.0