ethfs-cli v1.0.8

ethfs-cli

Installation

Globally:

npm install -g ethfs-cli
ethfs-cli upload -f <directory|file> -a <address> -p <private-key> -r [rpc] -t [upload-type]

Locally:

npm install ethfs-cli
npx ethfs-cli upload -f <directory|file> -a <address> -p <private-key> -r [rpc] -t [upload-type]

Command

Supported networks

Usage

Support EIP-3770 Address

ethereum
    eth:<name|address>

... 

galileo
    w3q-g:<name|address>       

Example

ethereum
    eth:ens.eth

...

galileo
    w3q-g:0x1825...2388

Create FlatDirectory Command

Ethereum is the default network if it's not specified, otherwise, you should use "--chainId" to set it. RPC should also be specified if the network is an unlisted network.

ethfs-cli create -p <privateKey>
ethfs-cli create -p <privateKey> -c [chainId]
ethfs-cli create -p <privateKey> -c [chainId] -r [rpc]

// output: contract address 

Example

ethfs-cli create -p 0x32...
ethfs-cli create -p 0x32... -c 5
ethfs-cli create -p 0x32... -c 1 -r https://rpc.ankr.com/eth

Upload Command

Upload files, you need to specify the upload type. The default type is blob:2. If you want to use name instead of FlatDirectory address, the name should be pointed to the FlatDirectory address in advance. Click here for details.

FlatDirectory address
  ethfs-cli upload -f <directory|file> -a <address> -p <privateKey> -r [rpc] -t [uploadType]
ens
  ethfs-cli upload -f <directory|file> -a <name> -p <privateKey> -r [rpc] -t [uploadType]
w3ns
  ethfs-cli upload -f <directory|file> -a <name> -p <privateKey> -r [rpc] -t [uploadType]

Example

FlatDirectory address
  ethfs-cli upload -f index.html -a gor:0x1825...2388 -p 0x32...
  ethfs-cli upload -f index.html -a xxx:0x1825...2388 -p 0x32... -r https://rpc.xxx -t 1
ens
  ethfs-cli upload -f dist -a eth:ens.eth -p 0x32... -r https://rpc.ankr.com/eth -t 2
w3ns
  ethfs-cli upload -f dist -a w3q-g:home.w3q -p 0x32... -t 2

Set FlatDirectory Default Entrance

FlatDirectory address
  ethfs-cli default -a <address> -f <fileName> -p <privateKey> -r [rpc]
ens
  ethfs-cli default -a <name> -f <fileName> -p <privateKey> -r [rpc]
w3ns
  ethfs-cli default -a <name> -f <fileName> -p <privateKey> -r [rpc]

Example

FlatDirectory address
  ethfs-cli default -a gor:0x1825...2388 -f index.html -p 0x32...
  ethfs-cli default -a xxx:0x1825...2388 -f index.html -p 0x32... -r https://rpc.xxx
ens
  ethfs-cli default -a eth:ens.eth -f index.html -p 0x32... -r https://rpc.ankr.com/eth
w3ns
  ethfs-cli default -a w3q-g:home.w3q -f index.html -p 0x32...  -r https://rpc.ankr.com/eth

Remove File

FlatDirectory address
  ethfs-cli remove -a <address> -f <fileName> -p <privateKey> -r [rpc]
ens
  ethfs-cli remove -a <name> -f <fileName> -p <privateKey> -r [rpc]
w3ns
  ethfs-cli remove -a <name> -f <fileName> -p <privateKey> -r [rpc]

Example

FlatDirectory address
  ethfs-cli remove -a gor:0x1825...2388 -f index.html -p 0x32...
  ethfs-cli remove -a xxx:0x1825...2388 -f index.html -p 0x32... -r https://rpc.xxx
ens
  ethfs-cli remove -a eth:ens.eth -f src/home.vue -p 0x32... -r https://rpc.ankr.com/eth
w3ns
  ethfs-cli remove -a w3q-g:home.w3q -f src/home.vue -p 0x32... -r https://rpc.ankr.com/eth

Download File

FlatDirectory address
  ethfs-cli download -a <address> -f <fileName> -r [rpc]
ens
  ethfs-cli download -a <name> -f <fileName> -r [rpc]
w3ns
  ethfs-cli download --address <name> --file <fileName> --rpc [rpc]

Example

FlatDirectory address
    npx ethfs-cli download -a gor:0x1825...2388 -f index.html
    npx ethfs-cli download -a xxx:0x1825...2388 -f index.html -r https://rpc.xxx
ens
    npx ethfs-cli download -a eth:ens.eth -f home.vue
w3ns
    npx ethfs-cli download --address w3q-g:home.w3q --file home.vue --rpc https://rpc.xxx

Repo

Github Repo