Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KevinOfNeu/rocket
NetDisk in command line.
https://github.com/KevinOfNeu/rocket
baidu cli netdisk parser qiniu rocket
Last synced: 7 days ago
JSON representation
NetDisk in command line.
- Host: GitHub
- URL: https://github.com/KevinOfNeu/rocket
- Owner: KevinOfNeu
- License: mit
- Archived: true
- Created: 2016-11-25T10:19:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T03:24:49.000Z (over 7 years ago)
- Last Synced: 2024-10-29T06:04:41.480Z (14 days ago)
- Topics: baidu, cli, netdisk, parser, qiniu, rocket
- Language: JavaScript
- Homepage: http://rocket.js.org
- Size: 29.3 KB
- Stars: 42
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rocket
==================
[](https://travis-ci.org/KevinOfNeu/rocket)
[]()
Self hosted netdisk, pure command line tool to to pull or pull files with Qiniu cloud.
## Features
- Fully command line operation!
- 100% self host.
- Support custom storage provider with Qiniu(七牛).
- Support index files with regex expression.
- Expressive command lines
- Easy config and use
- ...
## Screenshots
Soon!
## Installation & Preparation
`$ brew install node`
### 1. Register Qiniu(七牛) storage provider
[Register a free Qiniu account](http://www.qiniu.com/). Then create a new bucket.
Take bucket name down, then get accessKey and secretKey.
Finally, get your domain:
Take accessKey, secretKey domain and bucket name down, we will use it when config rocket :P.
### 2. CLI
`$ npm install -g rocket-cli`
After installation, type:
`$ rocket -h`
Succeed if you see the following tips.
```
Usage: rocket [options] [command]
Commands:
init [options] Init config file
config [options] [show] Config Qiniu bucket, domain, access key and secret key
add [options] Add dir or files to index
push [options] Push files to Qiniu cloud
ls [options] List files from local index
pull [options] Pull file from Qiniu cloud
Options:
-h, --help output usage information
-V, --version output the version number
```
## Commands & Usage
### Init config file
`$ rocket init`
If the config file already exists, you can use `-o` or `-overwrite` options to overwrite the old one.
The config file locates at `~/.rocket.json`.
### Config storage provider
`$ rocket config -b -a -s -d `
### Show config
List your cnfiguration.
`$ rocket config show`
### Add files to local index
`$ rocket add -d -r -f `
`-r` means recursively add files in sub directories.
`-f` can set filters using regex expression, use `.` for all files.
### Push files in local index to cloud
`$ rocket push -m [max upload workers. defailt = 5]`
`-m` set the maximum number of upload workers.
### List all indexed files
`$ rocket ls -o [offset] -l [limit]`
You can use `-o` and `-l` to set proper offset and limit if there are too much files in local index.
### Pull
`$ rocket pull -d [destination] `
This command will download file searched by key to destination directory, default directory is where this file uploaded.
## How dose it work?
*SOON!*
## TODO
- [x] Add timestamp when upload
- [x] Pull files to local(with default localPath).
- [ ] Examples & Articles
- [ ] Add rocket restore command（next version）
- [ ] Support multi config file.
- [x] Some default params.
- [x] Support pull file(s) to certain directory.
- [ ] Support multi object storage provider.
- [ ] Code refactor.
- [ ] Test case needed.
## Release Note
- [0.0.6] Add pull files function; Remove unneed command; Add show config operation; Add timestamp;
## Contribute
PR and issues are welcomed! Join and make it better!
## Info/Support
Email [email protected] for support!
## License
[MIT](LICENSE)