{"id":19767799,"url":"https://github.com/lighthouse-web3/lighthouse-package","last_synced_at":"2025-04-09T22:18:16.267Z","repository":{"id":37847268,"uuid":"429886765","full_name":"lighthouse-web3/lighthouse-package","owner":"lighthouse-web3","description":"cli tool and npm package for interacting with lighthouse","archived":false,"fork":false,"pushed_at":"2025-03-18T23:03:42.000Z","size":27622,"stargazers_count":19,"open_issues_count":4,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T22:18:11.827Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lighthouse-web3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-19T17:47:39.000Z","updated_at":"2025-03-18T23:03:47.000Z","dependencies_parsed_at":"2024-06-18T17:04:44.188Z","dependency_job_id":"01b0d583-46e2-445c-bcaa-6502054724c4","html_url":"https://github.com/lighthouse-web3/lighthouse-package","commit_stats":{"total_commits":583,"total_committers":5,"mean_commits":116.6,"dds":0.08919382504288165,"last_synced_commit":"d6df55b30929fe6f30eb1d9271cbab7d85b39e55"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lighthouse-web3%2Flighthouse-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lighthouse-web3%2Flighthouse-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lighthouse-web3%2Flighthouse-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lighthouse-web3%2Flighthouse-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lighthouse-web3","download_url":"https://codeload.github.com/lighthouse-web3/lighthouse-package/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119286,"owners_count":21050755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T04:32:26.976Z","updated_at":"2025-04-09T22:18:16.246Z","avatar_url":"https://github.com/lighthouse-web3.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lighthouse \u003cimg src=\"https://img.shields.io/badge/BETA-v0.3.7-green\"/\u003e\n\nLighthouse is a permanent decentralized file storage protocol that allows the ability to pay once and store forever. While traditionally, users need to repeatedly keep track and pay for their storage after every fixed amount of time, Lighthouse manages this for them and makes sure that user files are stored forever. The aim is to move users from a rent-based cost model where they are renting their own files on cloud storage to a permanent ownership model. It is built on top of IPFS, Filecoin, and Polygon. It uses the existing miner network and storage capacity of the filecoin network.\n\n## Installation\n\n```bash\nnpm install -g @lighthouse-web3/sdk\n```\n\n## CLI Usage\n\n```bash\n# create-wallet\nlighthouse-web3 create-wallet\n\n# import-wallet\nlighthouse-web3 import-wallet --key \u003cprivate_key\u003e\n\n# wallet-forget\nlighthouse-web3 wallet-forget\n\n# api-key\nlighthouse-web3 api-key --new\n\n# balance\nlighthouse-web3 balance\n\n# upload\nlighthouse-web3 upload \u003cpath\u003e\n\n# status\nlighthouse-web3 status \u003ccid\u003e\n\n# get-uploads\nlighthouse-web3 get-uploads\n\n# wallet\nlighthouse-web3 wallet\n```\n\n## NodeJs Example\n\n```javascript\nimport lighthouse from \"@lighthouse-web3/sdk\";\n\n// Create wallet\nconst wallet = await lighthouse.createWallet(\n  \"Password for wallet encryption\"\n);\n\n// Get wallet balance\nconst balance = await lighthouse.getBalance(publicKey);\n\n// Upload File\nconst uploadResponse = await lighthouse.upload('/home/cosmos/Desktop/wow.jpg', 'YOUR_API_KEY');\n\n```\n\n\u003e Refer [GitBook](https://docs.lighthouse.storage/lighthouse-1/)\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\nThis project is tested with [BrowserStack](https://www.browserstack.com/).\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flighthouse-web3%2Flighthouse-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flighthouse-web3%2Flighthouse-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flighthouse-web3%2Flighthouse-package/lists"}