-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1160 from wkentaro/doc-for-jsk-data-cli
[jsk_data] Documentation about `$ jsk_data` cli
- Loading branch information
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
jsk\_data | ||
========= | ||
|
||
A stack for data management tools which are used in JSK lab. | ||
|
||
|
||
`$ jsk_data` command | ||
-------------------- | ||
|
||
`jsk_data` is command line interface to rename, upload and download data, and | ||
this is fully designed for JSK lab members. | ||
(this command communicates with internal server in lab) | ||
|
||
There are following sub commands. See `jsk_data [sub command] --help` for more detail. | ||
|
||
* `ls`: List data in the server. | ||
|
||
Usage is `jsk_data ls [OPTIONS] [QUERY]`. | ||
|
||
* `get`: Download data from the server. | ||
|
||
Usage is `jsk_data put [OPTIONS] FILENAME`. | ||
|
||
* `put`: Upload data to the server. | ||
|
||
Usage is `jsk_data put [OPTIONS] FILENAME`. | ||
With `--public` option, it also uploads to | ||
[public Google Drive folder](https://drive.google.com/folderview?id=0B9P1L--7Wd2vUGplQkVLTFBWcFE), | ||
so please care about it when you handle secure data. | ||
|
||
* `pubinfo`: Show public data info. | ||
|
||
Usage is `jsk_data pubinfo [OPTIONS] FILENAME`. | ||
|
||
**Screencast** | ||
|
||
![](./images/jsk_data_cli_screencast.gif) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.