Lighthouse
  • 👋Introduction
  • Quick Start
  • How To
    • 🔑Create an API Key
    • 🔼Upload Data
      • 📁File
      • 🔤Text/JSON
      • 🔀Buffer
    • 🔒Upload Encrypted Data
      • 📁File
      • 🔤Text/JSON
      • 🔐Encryption Authentication
        • 📝Method 1: Signed Message
        • ⚕️Method 2: JWT
        • 📲Method 3: Passkey
    • Encryption Features
      • 👯Share File
      • ❌Revoke Access
      • 🔑Check Access Conditions
      • 🚪Token Gating
      • Chains Supported
      • 📃Access Control Conditions
      • 🔓Decrypt File
        • 🌐Browser Decrypt File
        • 💻NodeJS Decrypt File
      • 🚪Access control with zkTLS
    • 📂List Files
    • 💁File Info
    • 💰Get Balance
    • 🔁Retrieve File
    • 💾Check for Filecoin Deals
    • 🔄IPNS - Handle Mutable Data
    • 📦Migrate Files
    • 📌Pin CID
    • 💸Pay per use
    • Resize Image
    • 💻Use CLI Tools
  • zkTLS
  • 💾Filecoin First
    • Usage
    • 💰Pay Per Deal
  • Tutorials
    • 💸Pay to View Application
    • Use Python SDK
    • 📝Update Content with Lighthouse IPNS
    • 📹Add Video Player in UI
    • ✅Document Verification with PoDSI
    • 🎨Minting NFTs on EVM Chains
    • 🪙Minting NFTs on Solana
    • 👩‍💻Programmable Storage with Lighthouse SDK and Filecoin
    • 🔐Secure File Sharing
    • Upload Encrypted Files
    • 📄Token Gating and Custom Contract
    • 🔑Token Gating NFTs
    • 🏖️Pushing File Metadata Onchain
    • Use Radix Wallet on Lighthouse Filesdapp
  • Concepts
    • Glossary
    • IPFS CID Transition to v1
  • Support
    • 📞Contact
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. How To

Use CLI Tools

Lighthouse CLI tool to interact with the protocol

PreviousResize ImageNextzkTLS

Last updated 6 months ago

Was this helpful?

Installation

Install the npm package globally on your system

npm install -g @lighthouse-web3/sdk

in case you had our old package installed, you will need to uninstall that before installing the above package.

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

  1. wallet - Returns wallet public address and connected network

  2. create-wallet - Creates a new wallet

  3. import-wallet - Imports an existing wallet

  4. wallet-forget - Remove previously saved wallet

  5. reset-password - Change your password

  6. balance - Get the current balance of your wallet and data usage

  7. upload - Upload a file

  8. upload-encrypted - Upload a file with encryption

  9. decrypt-file - Decrypt and download the file

  10. share-file - Share direct access to the file

  11. revoke-access - Revoke direct access to the file

  12. deal-status - Get storage Filecoin deal status

  13. get-uploads - Get details of files uploaded

  14. api-key - Get a new API key

CLI Commands

💻
🛠️
❌
📄
🖼️