| description |
|---|
Lighthouse CLI tool to interact with the protocol |
:tools:Installation
Install the npm package globally on your system
npm install -g @lighthouse-web3/sdk
{% hint style="info" %} in case you had our old package installed, you will need to uninstall that before installing the above package. {% endhint %}
❌To uninstall the old package, run the following command:
npm uninstall -g lighthouse-web3
📄Commands
Run the following command in your CLI to see every function
lighthouse-web3 --help
The following commands are available with the Lighthouse CLI tool
wallet- Returns wallet public address and connected networkcreate-wallet- Creates a new walletimport-wallet- Imports an existing walletwallet-forget- Remove previously saved walletreset-password- Change your passwordbalance- Get the current balance of your wallet and data usageupload- Upload a fileupload-encrypted- Upload a file with encryptiondecrypt-file- Decrypt and download the fileshare-file- Share direct access to the filerevoke-access- Revoke direct access to the filedeal-status- Get storage Filecoin deal statusget-uploads- Get details of files uploadedapi-key- Get a new API key
:frame_photo:CLI Commands
