@@ -20,240 +20,7 @@ You can also run
20
20
21
21
to get the full description of any command:
22
22
23
- login
24
-
25
- USAGE
26
-
27
- gin login [<username>]
28
-
29
- DESCRIPTION
30
-
31
- Login to the GIN services.
32
-
33
- ARGUMENTS
34
-
35
- <username>
36
- If no username is specified on the command line, you will be
37
- prompted for it. The login command always prompts for a
38
- password.
39
-
40
- logout
41
-
42
- USAGE
43
-
44
- gin logout
45
-
46
- DESCRIPTION
47
-
48
- Logout of the GIN services.
49
-
50
- This command takes no arguments.
51
-
52
- create
53
-
54
- USAGE
55
-
56
- gin create [<name>] [<description>]
57
-
58
- DESCRIPTION
59
-
60
- Create a new repository on the GIN server.
61
-
62
- ARGUMENTS
63
-
64
- <name>
65
- The name of the repository. If no <name> is provided, you will be
66
- prompted for one. If you want to provide a description, you need to
67
- provide a repository name on the command line. Names should contain
68
- only alphanumeric characters, '.', '-', and '_'.
69
-
70
- <description>
71
- A repository description (optional). The description should be
72
- specified as a single argument. For most shells, this means the
73
- description should be in quotes.
74
-
75
- EXAMPLES
76
-
77
- Create a repository. Prompt for name
78
-
79
- $ gin create
80
-
81
- Create a repository named 'example' with a description
82
-
83
- $ gin create example "An example repository"
84
-
85
- Create a repository named 'example' with no description
86
-
87
- $ gin create example
88
-
89
- get
90
-
91
- USAGE
92
-
93
- gin get <repopath>
94
-
95
- DESCRIPTION
96
-
97
- Download a remote repository to a new directory and initialise the
98
- directory with the default options. The local directory is referred to as
99
- the 'clone' of the repository.
100
-
101
- ARGUMENTS
102
-
103
- <repopath>
104
- The repository path <repopath> must be specified on the command line.
105
- A repository path is the owner's username, followed by a "/" and the
106
- repository name.
107
-
108
- EXAMPLES
109
-
110
- Get and intialise the repository named 'example' owned by user 'alice'
111
-
112
- $ gin get alice/example
113
-
114
- Get and initialise the repository named 'eegdata' owned by user 'peter'
115
-
116
- $ gin get peter/eegdata
117
-
118
- ls
119
-
120
- USAGE
121
-
122
- gin ls [<directory>]...
123
-
124
- DESCRIPTION
125
-
126
- List one or more files or the contents of directories and the status of the
127
- files within it. With no arguments, lists the status of the files under the
128
- current directory. Directory listings are performed recursively.
129
-
130
- The meaning of the status abbreviations is as follows:
131
- OK: The file is part of the GIN repository and its contents are
132
- synchronised with the server.
133
- NC: The local file is a placeholder and its contents have not been
134
- downloaded.
135
- MD: The file has been modified locally and the changes have not been
136
- recorded yet.
137
- LC: The file has been modified locally, the changes have been recorded
138
- but they haven't been uploaded.
139
- ??: The file is not under repository control.
140
-
141
- ARGUMENTS
142
-
143
- <directory>
144
- One or more directories or files to list.
145
-
146
- upload
147
-
148
- USAGE
149
-
150
- gin upload
151
-
152
- DESCRIPTION
153
-
154
- Upload changes made in a local repository clone to the remote repository on
155
- the GIN server. This command must be called from within the local
156
- repository clone. All changes made will be sent to the server, including
157
- addition of new files, modifications and renaming of existing files, and
158
- file deletions.
159
-
160
- This command takes no arguments.
161
-
162
- download
163
-
164
- USAGE
165
-
166
- gin download
167
-
168
- DESCRIPTION
169
-
170
- Download changes made in the remote repository on the GIN server to the
171
- local repository clone. This command must be called from within the
172
- local repository clone. All changes made on the remote server will
173
- be retrieved, including addition of new files, modifications and renaming
174
- of existing files, and file deletions.
175
-
176
- This command takes no arguments.
177
-
178
- repos
179
-
180
- USAGE
181
-
182
- gin repos [<username>]
183
- gin repos -s, --shared-with-me
184
- gin repos -p, --public
185
-
186
-
187
- DESCRIPTION
188
-
189
- List repositories on the server that provide read access. If no argument is
190
- provided, it will list the repositories owned by the logged in user. If no
191
- user is logged in, it will list all public repositories.
192
-
193
- ARGUMENTS
194
-
195
- -s, --shared-with-me
196
- List all repositories shared with the logged in user.
197
-
198
- -p, --public
199
- List all public repositories.
200
-
201
- <username>
202
- The name of the user whose repositories should be listed. This
203
- consists of public repositories and repositories shared with the logged
204
- in user.
205
-
206
- info
207
-
208
- USAGE
209
-
210
- gin info [<username>]
211
-
212
- DESCRIPTION
213
-
214
- Print user information. If no argument is provided, it will print the
215
- information of the currently logged in user.
216
-
217
- Using this command with no argument can also be used to check if a user is
218
- currently logged in.
219
-
220
- ARGUMENTS
221
-
222
- <username>
223
- The name of the user whose information should be printed. This can be
224
- the username of the currently logged in user, in which case the command
225
- will print all the profile information with indicators for which data
226
- is publicly visible. If it is the username of a different user, only
227
- the publicly visible information is printed.
228
-
229
- keys
230
-
231
- USAGE
232
-
233
- gin keys [-v | --verbose]
234
- gin keys --add <filename>
235
-
236
- DESCRIPTION
237
-
238
- List or add SSH keys. If no argument is provided, it will list the
239
- description and fingerprint for each key associated with the logged in
240
- account.
241
-
242
- The command can also be used to add a public key to your account from an
243
- existing filename (see --add argument).
244
-
245
- ARGUMENTS
246
-
247
- -v, --verbose
248
- Verbose printing. Prints the entire public key when listing.
249
-
250
- --add <filename>
251
- Specify a filename which contains a public key to be added to the GIN
252
- server.
253
-
254
- EXAMPLES
255
-
256
- Add a public key to your account, as generated from the default ssh-keygen
257
- command
258
-
259
- $ gin keys --add ~/.ssh/id_rsa.pub
23
+ | command | arguments | description |
24
+ | ------- | --------- | ----------- |
25
+ | login | username | Login to the GIN services |
26
+ | | | If no username is specified on the command line, it will
0 commit comments