Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anishde12020/storli
A CLI to upload files to IPFS and interact with them using wbeb3.storage
https://github.com/anishde12020/storli
ipfs oclif web3
Last synced: 4 days ago
JSON representation
A CLI to upload files to IPFS and interact with them using wbeb3.storage
- Host: GitHub
- URL: https://github.com/anishde12020/storli
- Owner: AnishDe12020
- License: mit
- Created: 2022-05-16T11:33:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T15:28:35.000Z (over 1 year ago)
- Last Synced: 2024-12-16T01:07:47.083Z (22 days ago)
- Topics: ipfs, oclif, web3
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/storli
- Size: 1.05 MB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Storli
[](https://oclif.io)
[](https://npmjs.org/package/storli)
[](https://npmjs.org/package/storli)
[](https://github.com/AnishDe12020/storli/blob/main/package.json)
**A CLI to upload files to IPFS and interact with them using [web3.storage](https://web3.storage)**
* [Storli](#storli)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g storli
$ storli COMMAND
running command...
$ storli (--version)
storli/1.0.2 linux-x64 node-v16.14.2
$ storli --help [COMMAND]
USAGE
$ storli COMMAND
...
```
# Commands
* [`storli config`](#storli-config)
* [`storli download CID`](#storli-download-cid)
* [`storli help [COMMAND]`](#storli-help-command)
* [`storli list`](#storli-list)
* [`storli ls`](#storli-ls)
* [`storli status CID`](#storli-status-cid)
* [`storli upload FILEPATH`](#storli-upload-filepath)
## `storli config`
Configure the CLI
```
USAGE
$ storli config
DESCRIPTION
Configure the CLI
```
_See code: [dist/commands/config/index.ts](https://github.com/AnishDe12020/storli/blob/v1.0.2/dist/commands/config/index.ts)_
## `storli download CID`
Download files from an upload
```
USAGE
$ storli download [CID]
ARGUMENTS
CID The CID of the upload
DESCRIPTION
Download files from an upload
```
_See code: [dist/commands/download/index.ts](https://github.com/AnishDe12020/storli/blob/v1.0.2/dist/commands/download/index.ts)_
## `storli help [COMMAND]`
Display help for storli.
```
USAGE
$ storli help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for storli.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
## `storli list`
List all uploads made by you
```
USAGE
$ storli list
DESCRIPTION
List all uploads made by you
ALIASES
$ storli ls
```
_See code: [dist/commands/list/index.ts](https://github.com/AnishDe12020/storli/blob/v1.0.2/dist/commands/list/index.ts)_
## `storli ls`
List all uploads made by you
```
USAGE
$ storli ls
DESCRIPTION
List all uploads made by you
ALIASES
$ storli ls
```
## `storli status CID`
Check the status of an upload
```
USAGE
$ storli status [CID]
ARGUMENTS
CID The CID of the upload to check the status of
DESCRIPTION
Check the status of an upload
```
_See code: [dist/commands/status/index.ts](https://github.com/AnishDe12020/storli/blob/v1.0.2/dist/commands/status/index.ts)_
## `storli upload FILEPATH`
Upload a file or directory to IPFS
```
USAGE
$ storli upload [FILEPATH] [-n ] [-d]
ARGUMENTS
FILEPATH Filepath of the file or directory to upload
FLAGS
-d, --dontWrapCID Don't wrap the file/dir with the CID in IPFS (by default, it is wrapped, recommended to be used
when uploading a directory)
-n, --name= Name you want to give to the upload (defaults to Upload at )
DESCRIPTION
Upload a file or directory to IPFS
```
_See code: [dist/commands/upload/index.ts](https://github.com/AnishDe12020/storli/blob/v1.0.2/dist/commands/upload/index.ts)_