|
1 |
| -# GIN-cli |
| 1 | +# GIN-CLI |
2 | 2 |
|
3 | 3 | [](http://godoc.org/github.com/G-Node/gin-cli)
|
4 | 4 |
|
|
7 | 7 |
|
8 | 8 | ---
|
9 | 9 |
|
10 |
| -**G**-Node **In**frastructure command line client |
| 10 | +**G**-Node **In**frastructure **C**ommand **L**ine **C**lient |
11 | 11 |
|
12 | 12 | This package is a command line client for interfacing with repositories hosted on [GIN](https://gin.g-node.org).
|
13 |
| -It offers a simplified interface for downloading and uploading files from repositories hosted on Gin. |
14 |
| -For a guide on how to use the GIN service and this client, see the [GIN quick start](https://web.gin.g-node.org/G-Node/Info/wiki/Quick+start) page. |
| 13 | +It offers a simplified interface for downloading and uploading files from repositories hosted on GIN. |
15 | 14 |
|
16 |
| -## Usage |
| 15 | +It consists of commands for interfacing with the GIN web API (e.g., listing repositories, creating repositories, managing SSH keys) but primarily, it wraps **git** and **git-annex** commands to make working with data repositories easier. |
17 | 16 |
|
18 |
| -The following is a description of the available commands in the GIN client. |
19 |
| -In the command line, you can view a basic list of commands by running |
20 |
| - |
21 |
| - gin -h |
22 |
| - |
23 |
| -You can also run |
24 |
| - |
25 |
| - gin help <cmd> |
26 |
| - |
27 |
| -to get the full description of any command. |
28 |
| - |
29 |
| -The table below describes the commands and their arguments. |
30 |
| -Please note: |
31 |
| -- Arguments enclosed in square brackets (e.g., `[<filenames>]`) are optional. |
32 |
| - - Generally, when a command specifies that it accepts `[<filenames>]` it means the user can limit the application of the command to specific filenames and directories. Multiple arguments may be specified (separated by space). If none are listed, the command will apply to all files and directories below the _current working directory_. |
33 |
| -- Arguments listed together separated by a pipe (e.g., `--here | --no-clone`) denotes that the two options cannot be specified at the same time. |
34 |
| - |
35 |
| -GIN command line client |
36 |
| - |
37 |
| -Usage: |
38 |
| - |
39 |
| - gin <command> [<args>...] |
40 |
| - gin --help |
41 |
| - gin --version |
42 |
| - |
43 |
| -Options: |
44 |
| - |
45 |
| - -h --help This help screen |
46 |
| - --version Client version |
47 |
| - |
48 |
| -Commands: |
49 |
| - |
50 |
| - login [<username>] |
51 |
| - Login to the GIN services |
52 |
| - |
53 |
| - logout |
54 |
| - Logout from the GIN services |
55 |
| - |
56 |
| - create [--here | --no-clone] [<name>] [<description>] |
57 |
| - Create a repository on the remote server and clone it |
58 |
| - |
59 |
| - get <repopath> |
60 |
| - Retrieve (clone) a repository from the remote server |
61 |
| - |
62 |
| - ls [-s | --short | --json] [<filenames>] |
63 |
| - List the sync status of files in a local repository |
64 |
| - |
65 |
| - unlock [<filenames>] |
66 |
| - Unlock files for editing |
67 |
| - |
68 |
| - lock [<filenames>] |
69 |
| - Lock files |
70 |
| - |
71 |
| - upload [<filenames>] |
72 |
| - Upload local changes to a remote repository |
73 |
| - |
74 |
| - download [--content] |
75 |
| - Download all new information from a remote repository |
76 |
| - |
77 |
| - get-content [<filenames>] |
78 |
| - Download the content of files from a remote repository |
79 |
| - |
80 |
| - getc [<filenames>] |
81 |
| - Synonym for get-content |
82 |
| - |
83 |
| - remove-content [<filenames>] |
84 |
| - Remove the content of local files that have already been uploaded |
85 |
| - |
86 |
| - rmc [<filenames>] |
87 |
| - Synonym for remove-content |
88 |
| - |
89 |
| - repos [--shared | --all] |
90 |
| - List remote repositories |
91 |
| - |
92 |
| - repos [<username>] |
93 |
| - List available remote repositories for specific user |
94 |
| - |
95 |
| - info [<username>] |
96 |
| - Print user information |
97 |
| - |
98 |
| - keys [-v | --verbose] |
99 |
| - List the keys associated with the logged in user |
100 |
| - |
101 |
| - keys --add <filename> |
102 |
| - Add/upload a new public key to the GIN services |
103 |
| - |
104 |
| - help <command> |
105 |
| - Get help for individual commands |
106 |
| - |
107 |
| - |
108 |
| -Use 'help' followed by a command to see full description of the command. |
| 17 | +## Information, setup, and guides |
| 18 | +For installation instructions see the [GIN Client Setup](https://web.gin.g-node.org/G-Node/Info/wiki/GinCli) page. |
109 | 19 |
|
| 20 | +General information, help, and guides for using GIN can be found on the [GIN Info Wiki](https://web.gin.g-node.org/G-Node/info/wiki). |
| 21 | +Help and information for the client in particular can be on the following pages: |
| 22 | +- [Usage guide (tutorial)](https://web.gin.g-node.org/G-Node/Info/wiki/GinUsageTutorial) |
| 23 | +- [Useful recipes and short workflows](https://web.gin.g-node.org/G-Node/Info/wiki/GinCliRecipes) |
| 24 | +- [Detailed command overview](https://web.gin.g-node.org/G-Node/Info/wiki/GinClientHelp) |
0 commit comments