41e7017fbd14d1688feae3c0335262e78f40890a
cli_beta.md
... | ... | @@ -2,10 +2,11 @@ |
2 | 2 | |
3 | 3 | ## How do I get it? |
4 | 4 | |
5 | -email accounts@sbgrid.org with your info and we'll hook you up. |
|
5 | +[LINUX : sbgrid-cli_2.0.43_linux.tar.gz](https://sbgrid.org/wiki/downloads/sbgrid-cli_2.0.43_linux.tar.gz) |
|
6 | +[macOS : sbgrid-cli_2.0.43_macOS.tar.gz](https://sbgrid.org/wiki/downloads/sbgrid-cli_2.0.43_macOS.tar.gz) |
|
6 | 7 | |
7 | 8 | ## Supported OSes |
8 | -[Linux (CentOS/RHEL 7 or 8 recommended) or Apple OSX computers running MacOSX v10.12 - 10.14.](operatingsystems) |
|
9 | +[Linux (CentOS/RHEL 7 or 8 recommended) or Apple OSX computers running MacOSX v10.12 - 10.15.](operatingsystems) |
|
9 | 10 | |
10 | 11 | |
11 | 12 | MacOS 10.15 Catalina can be used, but a work-around is required to add the /programs path. |
... | ... | @@ -13,11 +14,12 @@ See [here for more info :](catalina) |
13 | 14 | |
14 | 15 | ### Pre-installation requirements |
15 | 16 | **Admin access required on your computer.** |
16 | - The SBGrid installation client will install the software tree to /opt/sbgrid and create a symlink from this directory to /programs. While admin privileges are not required to run the application, you will need admin privileges to create /opt/sbgrid and /programs . |
|
17 | + The SBGrid installation client will install the software tree to /opt/sbgrid and create a symlink from this directory to /programs. |
|
18 | + While admin privileges are not required to run the application, you will likely need admin privileges to create /opt/sbgrid and /programs . |
|
17 | 19 | |
18 | 20 | ``` |
19 | - $ ./sbgrid |
|
20 | -Usage: sbgrid [command] [options] |
|
21 | + $ ./sbgrid-cli |
|
22 | +Usage: sbgrid-cli [command] [options] |
|
21 | 23 | |
22 | 24 | Commands: |
23 | 25 | help [command] command-specific help |
... | ... | @@ -90,7 +92,7 @@ Trouble activating? See Troubleshooting options further down this page. |
90 | 92 | *reactivate* can restore from a saved config file. See below. |
91 | 93 | |
92 | 94 | ``` |
93 | - $ ./sbgrid reactivate -h |
|
95 | + $ ./sbgrid-cli reactivate -h |
|
94 | 96 | Usage: reactivate [options] <configFilePath> [packagesPath] |
95 | 97 | |
96 | 98 | reactivate a new instance of an installation using a “saved” configuration file |
... | ... | @@ -128,7 +130,7 @@ Options: |
128 | 130 | Shows available updated version and titles |
129 | 131 | |
130 | 132 | ``` |
131 | -./sbgrid updates |
|
133 | +./sbgrid-cli updates |
|
132 | 134 | ``` |
133 | 135 | |
134 | 136 | **obsolete** |
... | ... | @@ -137,7 +139,7 @@ Shows obsolete versions that will be removed. |
137 | 139 | Obsolete versions are previously installed versions no longer included in the SBGrid installation. |
138 | 140 | |
139 | 141 | ``` |
140 | -./sbgrid obsolete |
|
142 | +./sbgrid-cli obsolete |
|
141 | 143 | ``` |
142 | 144 | |
143 | 145 | ### Getting Information about titles |
... | ... | @@ -160,7 +162,7 @@ Options: |
160 | 162 | For example, info for RELION : |
161 | 163 | |
162 | 164 | ``` |
163 | - $ ./sbgrid info relion |
|
165 | + $ ./sbgrid-cli info relion |
|
164 | 166 | Fetching requested info... |
165 | 167 | ------------------------------------------------------------------------------------ |
166 | 168 | Package information for relion (i386-mac): |
... | ... | @@ -234,37 +236,37 @@ Options: |
234 | 236 | Install a single default version of an application : |
235 | 237 | |
236 | 238 | ``` |
237 | -./sbgrid install relion |
|
239 | +./sbgrid-cli install relion |
|
238 | 240 | ``` |
239 | 241 | |
240 | 242 | Install a specific version of a relion : |
241 | 243 | |
242 | 244 | ``` |
243 | - ./sbgrid install relion@3.0.8 |
|
245 | + ./sbgrid-cli install relion@3.0.8 |
|
244 | 246 | ``` |
245 | 247 | |
246 | 248 | Install all versions of relion : |
247 | 249 | |
248 | 250 | ``` |
249 | - ./sbgrid install relion@all |
|
251 | + ./sbgrid-cli install relion@all |
|
250 | 252 | ``` |
251 | 253 | |
252 | 254 | Install the 'Electron Microscopy' collection of titles (see above *list* command to list *collections*): |
253 | 255 | |
254 | 256 | ``` |
255 | - $ ./sbgrid install -c 'Electron Microscopy' |
|
257 | + $ ./sbgrid-cli install -c 'Electron Microscopy' |
|
256 | 258 | ``` |
257 | 259 | |
258 | 260 | Install all default versions of all titles : |
259 | 261 | |
260 | 262 | ``` |
261 | - ./sbgrid install --all-defaults |
|
263 | + ./sbgrid-cli install --all-defaults |
|
262 | 264 | ``` |
263 | 265 | |
264 | 266 | Install all versions of all titles ( The full collection): |
265 | 267 | |
266 | 268 | ``` |
267 | - ./sbgrid install --all-versions |
|
269 | + ./sbgrid-cli install --all-versions |
|
268 | 270 | ``` |
269 | 271 | |
270 | 272 | **remove** |
... | ... | @@ -292,7 +294,7 @@ Updates are performed when default titles change to a new version or bugs are fi |
292 | 294 | **update** |
293 | 295 | |
294 | 296 | ``` |
295 | -./sbgrid update relion |
|
297 | +./sbgrid-cli update relion |
|
296 | 298 | ``` |
297 | 299 | |
298 | 300 | ### Remove obsolete titles |
... | ... | @@ -302,7 +304,7 @@ Use the obsolete flag to list or remove obsolete versions or titles |
302 | 304 | **obsolete** |
303 | 305 | |
304 | 306 | ``` |
305 | - $ ./sbgrid obsolete -h |
|
307 | + $ ./sbgrid-cli obsolete -h |
|
306 | 308 | Usage: obsolete [options] |
307 | 309 | |
308 | 310 | list obsolete software versions |
... | ... | @@ -340,13 +342,13 @@ Options: |
340 | 342 | For example running |
341 | 343 | |
342 | 344 | ``` |
343 | -./sbgrid admin |
|
345 | +./sbgrid-cli admin |
|
344 | 346 | ``` |
345 | 347 | |
346 | 348 | will install all default, update all installed titles and remove all obsolete versions while |
347 | 349 | |
348 | 350 | ``` |
349 | -./sbgrid admin -a |
|
351 | +./sbgrid-cli admin -a |
|
350 | 352 | ``` |
351 | 353 | |
352 | 354 | will install all versions of all titles, add any new titles, update any pending updates, and remove obsolete versions. |