@apollo-annotation/cli 0.1.18 → 0.1.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/README.md +374 -135
  2. package/bin/dev.js +2 -2
  3. package/bin/run.js +2 -2
  4. package/dist/ApolloConf.js +1 -0
  5. package/dist/baseCommand.d.ts +1 -1
  6. package/dist/baseCommand.js +7 -7
  7. package/dist/commands/assembly/add-from-fasta.d.ts +23 -0
  8. package/dist/commands/assembly/add-from-fasta.js +165 -0
  9. package/dist/commands/assembly/{add-gff.d.ts → add-from-gff.d.ts} +5 -3
  10. package/dist/commands/assembly/{add-gff.js → add-from-gff.js} +20 -22
  11. package/dist/commands/assembly/check.js +9 -9
  12. package/dist/commands/assembly/delete.js +4 -4
  13. package/dist/commands/assembly/get.js +4 -4
  14. package/dist/commands/assembly/get.test.js +3 -3
  15. package/dist/commands/assembly/sequence.js +8 -14
  16. package/dist/commands/change/get.js +7 -7
  17. package/dist/commands/change/get.test.js +1 -1
  18. package/dist/commands/config.js +4 -5
  19. package/dist/commands/feature/add-child.js +18 -19
  20. package/dist/commands/feature/check.js +11 -11
  21. package/dist/commands/feature/copy.js +12 -14
  22. package/dist/commands/feature/delete.js +13 -19
  23. package/dist/commands/feature/edit-attribute.js +18 -11
  24. package/dist/commands/feature/edit-coords.js +36 -21
  25. package/dist/commands/feature/edit-type.js +7 -11
  26. package/dist/commands/feature/edit.js +5 -6
  27. package/dist/commands/feature/get-id.js +5 -6
  28. package/dist/commands/feature/get.js +3 -4
  29. package/dist/commands/feature/import.d.ts +2 -2
  30. package/dist/commands/feature/import.js +26 -39
  31. package/dist/commands/feature/search.js +7 -7
  32. package/dist/commands/file/delete.d.ts +13 -0
  33. package/dist/commands/file/delete.js +58 -0
  34. package/dist/commands/file/download.d.ts +14 -0
  35. package/dist/commands/file/download.js +45 -0
  36. package/dist/commands/file/get.d.ts +13 -0
  37. package/dist/commands/file/get.js +38 -0
  38. package/dist/commands/file/upload.d.ts +16 -0
  39. package/dist/commands/file/upload.js +88 -0
  40. package/dist/commands/jbrowse/get-config.d.ts +10 -0
  41. package/dist/commands/jbrowse/get-config.js +21 -0
  42. package/dist/commands/jbrowse/set-config.d.ts +13 -0
  43. package/dist/commands/jbrowse/set-config.js +51 -0
  44. package/dist/commands/login.js +12 -16
  45. package/dist/commands/logout.js +3 -3
  46. package/dist/commands/{assembly/add-fasta.d.ts → refseq/add-alias.d.ts} +3 -4
  47. package/dist/commands/refseq/add-alias.js +72 -0
  48. package/dist/commands/refseq/get.js +8 -8
  49. package/dist/commands/status.js +5 -4
  50. package/dist/commands/user/get.js +3 -3
  51. package/dist/commands/user/get.test.js +1 -1
  52. package/dist/fileCommand.d.ts +5 -0
  53. package/dist/fileCommand.js +76 -0
  54. package/dist/test/fixtures.js +2 -2
  55. package/dist/utils.d.ts +20 -9
  56. package/dist/utils.js +33 -80
  57. package/oclif.manifest.json +495 -58
  58. package/package.json +56 -42
  59. package/dist/commands/assembly/add-fasta.js +0 -88
package/README.md CHANGED
@@ -1,101 +1,130 @@
1
1
  # Table of contents
2
2
 
3
3
  <!-- toc -->
4
- * [Table of contents](#table-of-contents)
5
- * [Usage](#usage)
6
- * [Commands](#commands)
4
+
5
+ - [Table of contents](#table-of-contents)
6
+ - [Usage](#usage)
7
+ - [Commands](#commands)
7
8
  <!-- tocstop -->
8
9
 
9
10
  # Usage
10
11
 
11
12
  <!-- usage -->
13
+
12
14
  ```sh-session
13
15
  $ npm install -g @apollo-annotation/cli
14
16
  $ apollo COMMAND
15
17
  running command...
16
18
  $ apollo (--version)
17
- @apollo-annotation/cli/0.1.18 linux-x64 node-v18.20.3
19
+ @apollo-annotation/cli/0.1.20 linux-x64 node-v18.20.4
18
20
  $ apollo --help [COMMAND]
19
21
  USAGE
20
22
  $ apollo COMMAND
21
23
  ...
22
24
  ```
25
+
23
26
  <!-- usagestop -->
24
27
 
25
28
  # Commands
26
29
 
27
30
  <!-- commands -->
28
- * [`apollo assembly add-fasta`](#apollo-assembly-add-fasta)
29
- * [`apollo assembly add-gff`](#apollo-assembly-add-gff)
30
- * [`apollo assembly check`](#apollo-assembly-check)
31
- * [`apollo assembly delete`](#apollo-assembly-delete)
32
- * [`apollo assembly get`](#apollo-assembly-get)
33
- * [`apollo assembly sequence`](#apollo-assembly-sequence)
34
- * [`apollo change get`](#apollo-change-get)
35
- * [`apollo config [KEY] [VALUE]`](#apollo-config-key-value)
36
- * [`apollo feature add-child`](#apollo-feature-add-child)
37
- * [`apollo feature check`](#apollo-feature-check)
38
- * [`apollo feature copy`](#apollo-feature-copy)
39
- * [`apollo feature delete`](#apollo-feature-delete)
40
- * [`apollo feature edit`](#apollo-feature-edit)
41
- * [`apollo feature edit-attribute`](#apollo-feature-edit-attribute)
42
- * [`apollo feature edit-coords`](#apollo-feature-edit-coords)
43
- * [`apollo feature edit-type`](#apollo-feature-edit-type)
44
- * [`apollo feature get`](#apollo-feature-get)
45
- * [`apollo feature get-id`](#apollo-feature-get-id)
46
- * [`apollo feature import`](#apollo-feature-import)
47
- * [`apollo feature search`](#apollo-feature-search)
48
- * [`apollo help [COMMANDS]`](#apollo-help-commands)
49
- * [`apollo login`](#apollo-login)
50
- * [`apollo logout`](#apollo-logout)
51
- * [`apollo refseq get`](#apollo-refseq-get)
52
- * [`apollo status`](#apollo-status)
53
- * [`apollo user get`](#apollo-user-get)
54
-
55
- ## `apollo assembly add-fasta`
56
-
57
- Add new assembly from local or external fasta file
58
-
59
- ```
60
- USAGE
61
- $ apollo assembly add-fasta -i <value> [--profile <value>] [--config-file <value>] [-a <value>] [-x <value>] [-f]
31
+
32
+ - [`apollo assembly add-from-fasta INPUT`](#apollo-assembly-add-from-fasta-input)
33
+ - [`apollo assembly add-from-gff INPUT-FILE`](#apollo-assembly-add-from-gff-input-file)
34
+ - [`apollo assembly check`](#apollo-assembly-check)
35
+ - [`apollo assembly delete`](#apollo-assembly-delete)
36
+ - [`apollo assembly get`](#apollo-assembly-get)
37
+ - [`apollo assembly sequence`](#apollo-assembly-sequence)
38
+ - [`apollo change get`](#apollo-change-get)
39
+ - [`apollo config [KEY] [VALUE]`](#apollo-config-key-value)
40
+ - [`apollo feature add-child`](#apollo-feature-add-child)
41
+ - [`apollo feature check`](#apollo-feature-check)
42
+ - [`apollo feature copy`](#apollo-feature-copy)
43
+ - [`apollo feature delete`](#apollo-feature-delete)
44
+ - [`apollo feature edit`](#apollo-feature-edit)
45
+ - [`apollo feature edit-attribute`](#apollo-feature-edit-attribute)
46
+ - [`apollo feature edit-coords`](#apollo-feature-edit-coords)
47
+ - [`apollo feature edit-type`](#apollo-feature-edit-type)
48
+ - [`apollo feature get`](#apollo-feature-get)
49
+ - [`apollo feature get-id`](#apollo-feature-get-id)
50
+ - [`apollo feature import`](#apollo-feature-import)
51
+ - [`apollo feature search`](#apollo-feature-search)
52
+ - [`apollo file delete`](#apollo-file-delete)
53
+ - [`apollo file download`](#apollo-file-download)
54
+ - [`apollo file get`](#apollo-file-get)
55
+ - [`apollo file upload`](#apollo-file-upload)
56
+ - [`apollo help [COMMANDS]`](#apollo-help-commands)
57
+ - [`apollo jbrowse get-config`](#apollo-jbrowse-get-config)
58
+ - [`apollo jbrowse set-config INPUTFILE`](#apollo-jbrowse-set-config-inputfile)
59
+ - [`apollo login`](#apollo-login)
60
+ - [`apollo logout`](#apollo-logout)
61
+ - [`apollo refseq add-alias`](#apollo-refseq-add-alias)
62
+ - [`apollo refseq get`](#apollo-refseq-get)
63
+ - [`apollo status`](#apollo-status)
64
+ - [`apollo user get`](#apollo-user-get)
65
+
66
+ ## `apollo assembly add-from-fasta INPUT`
67
+
68
+ Add a new assembly from fasta input
69
+
70
+ ```
71
+ USAGE
72
+ $ apollo assembly add-from-fasta INPUT [--profile <value>] [--config-file <value>] [-a <value>] [-x <value>] [-f] [-n]
73
+ [--fai <value>] [--gzi <value>] [-z | -d]
74
+
75
+ ARGUMENTS
76
+ INPUT Input fasta file, local or remote, or id of a previously uploaded file
62
77
 
63
78
  FLAGS
64
79
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
80
+ -d, --decompressed For local file input: Override autodetection and instruct that input is decompressed
65
81
  -f, --force Delete existing assembly, if it exists
66
- -i, --input-file=<value> (required) Input fasta file
67
- -x, --index=<value> URL of the index. Required if input is an external source and ignored if input is a local
68
- file
82
+ -n, --not-editable The fasta sequence is not editable. Apollo will not load it into the database and instead
83
+ use the provided indexes to query it. This option assumes the fasta file is bgzip'd with
84
+ `bgzip` and indexed with `samtools faidx`. Indexes should be named <my.fasta.gz>.gzi and
85
+ <my.fasta.gz>.fai unless options --fai and --gzi are set
86
+ -x, --index=<value> URL of the index. Required if input is an external source
87
+ -z, --gzip For local file input: Override autodetection and instruct that input is gzip compressed
69
88
  --config-file=<value> Use this config file (mostly for testing)
89
+ --fai=<value> Fasta index of the (not-editable) fasta file
90
+ --gzi=<value> Gzi index of the (not-editable) fasta file
70
91
  --profile=<value> Use credentials from this profile
71
92
 
72
93
  DESCRIPTION
73
- Add new assembly from local or external fasta file
94
+ Add a new assembly from fasta input
95
+
96
+ Add new assembly. The input fasta may be:
97
+ * A local file
98
+ * An external fasta file
99
+ * The id of a file previously uploaded to Apollo
74
100
 
75
101
  EXAMPLES
76
102
  From local file:
77
103
 
78
- $ apollo assembly add-fasta -i genome.fa -a myAssembly
104
+ $ apollo assembly add-from-fasta genome.fa -a myAssembly
79
105
 
80
106
  From external source we also need the URL of the index:
81
107
 
82
- $ apollo assembly add-fasta -i https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly
108
+ $ apollo assembly add-from-fasta https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly
83
109
  ```
84
110
 
85
- _See code: [src/commands/assembly/add-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/add-fasta.ts)_
111
+ _See code:
112
+ [src/commands/assembly/add-from-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/add-from-fasta.ts)_
86
113
 
87
- ## `apollo assembly add-gff`
114
+ ## `apollo assembly add-from-gff INPUT-FILE`
88
115
 
89
116
  Add new assembly from gff or gft file
90
117
 
91
118
  ```
92
119
  USAGE
93
- $ apollo assembly add-gff -i <value> [--profile <value>] [--config-file <value>] [-a <value>] [-o] [-f]
120
+ $ apollo assembly add-from-gff INPUT-FILE [--profile <value>] [--config-file <value>] [-a <value>] [-o] [-f]
121
+
122
+ ARGUMENTS
123
+ INPUT-FILE Input gff file
94
124
 
95
125
  FLAGS
96
126
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
97
127
  -f, --force Delete existing assembly, if it exists
98
- -i, --input-file=<value> (required) Input gff or gtf file
99
128
  -o, --omit-features Do not import features, only upload the sequences
100
129
  --config-file=<value> Use this config file (mostly for testing)
101
130
  --profile=<value> Use credentials from this profile
@@ -103,20 +132,20 @@ FLAGS
103
132
  DESCRIPTION
104
133
  Add new assembly from gff or gft file
105
134
 
106
- The gff file is expected to contain sequences as per gff specifications.
107
- Features are also imported by default.
135
+ The gff file is expected to contain sequences as per gff specifications. Features are also imported by default.
108
136
 
109
137
  EXAMPLES
110
138
  Import sequences and features:
111
139
 
112
- $ apollo assembly add-gff -i genome.gff -a myAssembly
140
+ $ apollo assembly add-from-gff -i genome.gff -a myAssembly
113
141
 
114
142
  Import sequences only:
115
143
 
116
- $ apollo assembly add-gff -i genome.gff -a myAssembly -o
144
+ $ apollo assembly add-from-gff genome.gff -a myAssembly -o
117
145
  ```
118
146
 
119
- _See code: [src/commands/assembly/add-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/add-gff.ts)_
147
+ _See code:
148
+ [src/commands/assembly/add-from-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/add-from-gff.ts)_
120
149
 
121
150
  ## `apollo assembly check`
122
151
 
@@ -136,9 +165,8 @@ FLAGS
136
165
  DESCRIPTION
137
166
  Add, view, or delete checks to assembly
138
167
 
139
- Manage checks, i.e. the rules ensuring features in an assembly are plausible.
140
- This command only sets the checks to apply, to retrieve features flagged by
141
- these checks use `apollo feature check`.
168
+ Manage checks, i.e. the rules ensuring features in an assembly are plausible. This command only sets the checks to
169
+ apply, to retrieve features flagged by these checks use `apollo feature check`.
142
170
 
143
171
  EXAMPLES
144
172
  View available check types:
@@ -158,7 +186,8 @@ EXAMPLES
158
186
  $ apollo assembly check -a hg19 -c CDSCheck --delete
159
187
  ```
160
188
 
161
- _See code: [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/check.ts)_
189
+ _See code:
190
+ [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/check.ts)_
162
191
 
163
192
  ## `apollo assembly delete`
164
193
 
@@ -185,7 +214,8 @@ EXAMPLES
185
214
  $ apollo assembly delete -a mouse 6605826fbd0eee691f83e73f
186
215
  ```
187
216
 
188
- _See code: [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/delete.ts)_
217
+ _See code:
218
+ [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/delete.ts)_
189
219
 
190
220
  ## `apollo assembly get`
191
221
 
@@ -206,7 +236,8 @@ DESCRIPTION
206
236
  Print to stdout the list of assemblies in json format
207
237
  ```
208
238
 
209
- _See code: [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/get.ts)_
239
+ _See code:
240
+ [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/get.ts)_
210
241
 
211
242
  ## `apollo assembly sequence`
212
243
 
@@ -240,7 +271,8 @@ EXAMPLES
240
271
  $ apollo assembly sequence -a myAssembly -r chr1 -s 1 -e 1000
241
272
  ```
242
273
 
243
- _See code: [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/assembly/sequence.ts)_
274
+ _See code:
275
+ [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/sequence.ts)_
244
276
 
245
277
  ## `apollo change get`
246
278
 
@@ -258,13 +290,13 @@ FLAGS
258
290
  DESCRIPTION
259
291
  Get list of changes
260
292
 
261
- Return the change log in json format. Note that when an assembly is deleted the
262
- link between common name and ID is lost (it can still be recovered by inspecting
263
- the change log but at present this task is left to the user). In such cases you
264
- need to use the assembly ID.
293
+ Return the change log in json format. Note that when an assembly is deleted the link between common name and ID is
294
+ lost (it can still be recovered by inspecting the change log but at present this task is left to the user). In such
295
+ cases you need to use the assembly ID.
265
296
  ```
266
297
 
267
- _See code: [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/change/get.ts)_
298
+ _See code:
299
+ [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/change/get.ts)_
268
300
 
269
301
  ## `apollo config [KEY] [VALUE]`
270
302
 
@@ -286,15 +318,14 @@ FLAGS
286
318
  DESCRIPTION
287
319
  Get or set apollo configuration options
288
320
 
289
- Use this command to create or edit a user profile with credentials to access
290
- Apollo. Configuration options are:
321
+ Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:
291
322
 
292
323
  - address:
293
324
  Address and port e.g http://localhost:3999
294
325
 
295
326
  - accessType:
296
- How to access Apollo. accessType is typically one of: google, microsoft, guest,
297
- root. Allowed types depend on your Apollo setup
327
+ How to access Apollo. accessType is typically one of: google, microsoft, guest, root. Allowed types depend on your
328
+ Apollo setup
298
329
 
299
330
  - accessToken:
300
331
  Access token. Usually inserted by `apollo login`
@@ -319,7 +350,8 @@ EXAMPLES
319
350
  $ apollo config address
320
351
  ```
321
352
 
322
- _See code: [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/config.ts)_
353
+ _See code:
354
+ [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/config.ts)_
323
355
 
324
356
  ## `apollo feature add-child`
325
357
 
@@ -340,16 +372,17 @@ FLAGS
340
372
  DESCRIPTION
341
373
  Add a child feature (e.g. add an exon to an mRNA)
342
374
 
343
- See the other commands under `apollo feature` to retrive the parent ID of
344
- interest and to populate the child feature with attributes.
375
+ See the other commands under `apollo feature` to retrive the parent ID of interest and to populate the child feature
376
+ with attributes.
345
377
 
346
378
  EXAMPLES
347
379
  Add an exon at genomic coordinates 10..20 to this feature ID:
348
380
 
349
- $ apollo feature add-child -i 6605826fbd0eee691f83e73f -t exon -s 10 -e 20
381
+ $ apollo feature add-child -i 660...73f -t exon -s 10 -e 20
350
382
  ```
351
383
 
352
- _See code: [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/add-child.ts)_
384
+ _See code:
385
+ [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/add-child.ts)_
353
386
 
354
387
  ## `apollo feature check`
355
388
 
@@ -368,9 +401,8 @@ FLAGS
368
401
  DESCRIPTION
369
402
  Get check results
370
403
 
371
- Use this command to view which features fail checks along with the reason for
372
- failing. Use `apollo assembly check` for managing which checks should be applied
373
- to an assembly
404
+ Use this command to view which features fail checks along with the reason for failing.Use `apollo assembly check` for
405
+ managing which checks should be applied to an assembly
374
406
 
375
407
  EXAMPLES
376
408
  Get all check results in the database:
@@ -382,7 +414,8 @@ EXAMPLES
382
414
  $ apollo feature check -a hg19
383
415
  ```
384
416
 
385
- _See code: [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/check.ts)_
417
+ _See code:
418
+ [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/check.ts)_
386
419
 
387
420
  ## `apollo feature copy`
388
421
 
@@ -403,9 +436,8 @@ FLAGS
403
436
  DESCRIPTION
404
437
  Copy a feature to another location
405
438
 
406
- The feature may be copied to the same or to a different assembly. he destination
407
- reference sequence may be selected by name only if unique in the database or by
408
- name and assembly or by identifier.
439
+ The feature may be copied to the same or to a different assembly. The destination reference sequence may be selected
440
+ by name only if unique in the database or by name and assembly or by identifier.
409
441
 
410
442
  EXAMPLES
411
443
  Copy this feature ID to chr1:100 in assembly hg38:
@@ -413,7 +445,8 @@ EXAMPLES
413
445
  $ apollo feature copy -i 6605826fbd0eee691f83e73f -r chr1 -s 100 -a hg38
414
446
  ```
415
447
 
416
- _See code: [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/copy.ts)_
448
+ _See code:
449
+ [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/copy.ts)_
417
450
 
418
451
  ## `apollo feature delete`
419
452
 
@@ -433,11 +466,11 @@ FLAGS
433
466
  DESCRIPTION
434
467
  Delete one or more features by ID
435
468
 
436
- Note that deleting a child feature after deleting its parent will result in an
437
- error unless you set -f/--force.
469
+ Note that deleting a child feature after deleting its parent will result in an error unless you set -f/--force.
438
470
  ```
439
471
 
440
- _See code: [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/delete.ts)_
472
+ _See code:
473
+ [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/delete.ts)_
441
474
 
442
475
  ## `apollo feature edit`
443
476
 
@@ -455,12 +488,11 @@ FLAGS
455
488
  DESCRIPTION
456
489
  Edit features using an appropiate json input
457
490
 
458
- Edit a feature by submitting a json input with all the required attributes for
459
- Apollo to process it. This is a very low level command which most users probably
460
- do not need.
491
+ Edit a feature by submitting a json input with all the required attributes for Apollo to process it. This is a very
492
+ low level command which most users probably do not need.
461
493
 
462
- Input may be a json string or a json file and it may be an array of changes.
463
- This is an example input for editing feature type:
494
+ Input may be a json string or a json file and it may be an array of changes. This is an example input for editing
495
+ feature type:
464
496
 
465
497
  {
466
498
  "typeName": "TypeChange",
@@ -479,7 +511,8 @@ EXAMPLES
479
511
  echo '{"typeName": ... "newType": "G_quartet"}' | apollo feature edit -j -
480
512
  ```
481
513
 
482
- _See code: [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/edit.ts)_
514
+ _See code:
515
+ [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/edit.ts)_
483
516
 
484
517
  ## `apollo feature edit-attribute`
485
518
 
@@ -501,9 +534,8 @@ FLAGS
501
534
  DESCRIPTION
502
535
  Add, edit, or view a feature attribute
503
536
 
504
- Be aware that there is no checking whether attributes names and values are
505
- valid. For example, you can create non-unique ID attributes or you can set gene
506
- ontology terms to non-existing terms
537
+ Be aware that there is no checking whether attributes names and values are valid. For example, you can create
538
+ non-unique ID attributes or you can set gene ontology terms to non-existing terms
507
539
 
508
540
  EXAMPLES
509
541
  Add attribute "domains" with a list of values:
@@ -519,7 +551,8 @@ EXAMPLES
519
551
  $ apollo feature edit-attribute -i 66...3f -a domains -d
520
552
  ```
521
553
 
522
- _See code: [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
554
+ _See code:
555
+ [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
523
556
 
524
557
  ## `apollo feature edit-coords`
525
558
 
@@ -539,9 +572,8 @@ FLAGS
539
572
  DESCRIPTION
540
573
  Edit feature start and/or end coordinates
541
574
 
542
- If editing a child feature that new coordinates must be within the parent's
543
- coordinates. To get the identifier of the feature to edit consider using `apollo
544
- feature get` or `apollo feature search`
575
+ If editing a child feature that new coordinates must be within the parent's coordinates.To get the identifier of the
576
+ feature to edit consider using `apollo feature get` or `apollo feature search`
545
577
 
546
578
  EXAMPLES
547
579
  Edit start and end:
@@ -553,7 +585,8 @@ EXAMPLES
553
585
  $ apollo feature edit-coords -i abc...xyz -e 2000
554
586
  ```
555
587
 
556
- _See code: [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
588
+ _See code:
589
+ [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
557
590
 
558
591
  ## `apollo feature edit-type`
559
592
 
@@ -572,11 +605,12 @@ FLAGS
572
605
  DESCRIPTION
573
606
  Edit or view feature type
574
607
 
575
- Feature type is column 3 in gff format. It must be a valid sequence ontology
576
- term although but the valifdity of the new term is not checked.
608
+ Feature type is column 3 in gff format.It must be a valid sequence ontology term although but the valifdity of the new
609
+ term is not checked.
577
610
  ```
578
611
 
579
- _See code: [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/edit-type.ts)_
612
+ _See code:
613
+ [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/edit-type.ts)_
580
614
 
581
615
  ## `apollo feature get`
582
616
 
@@ -603,13 +637,14 @@ EXAMPLES
603
637
 
604
638
  $ apollo feature get -a myAssembly
605
639
 
606
- Get features intersecting chr1:1..1000. You can omit the assembly name if there
607
- are no other reference sequences named chr1:
640
+ Get features intersecting chr1:1..1000. You can omit the assembly name if there are no other reference sequences
641
+ named chr1:
608
642
 
609
643
  $ apollo feature get -a myAssembly -r chr1 -s 1 -e 1000
610
644
  ```
611
645
 
612
- _See code: [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/get.ts)_
646
+ _See code:
647
+ [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/get.ts)_
613
648
 
614
649
  ## `apollo feature get-id`
615
650
 
@@ -620,8 +655,7 @@ USAGE
620
655
  $ apollo feature get-id [--profile <value>] [--config-file <value>] [-i <value>]
621
656
 
622
657
  FLAGS
623
- -i, --feature-id=<value>... [default: -] Retrieves feature with these IDs. Use
624
- "-" to read IDs from stdin (one per
658
+ -i, --feature-id=<value>... [default: -] Retrieves feature with these IDs. Use "-" to read IDs from stdin (one per
625
659
  line)
626
660
  --config-file=<value> Use this config file (mostly for testing)
627
661
  --profile=<value> Use credentials from this profile
@@ -629,8 +663,7 @@ FLAGS
629
663
  DESCRIPTION
630
664
  Get features given their identifiers
631
665
 
632
- Invalid identifiers or identifiers not found in the database will be silently
633
- ignored
666
+ Invalid identifiers or identifiers not found in the database will be silently ignored
634
667
 
635
668
  EXAMPLES
636
669
  Get features for these identifiers:
@@ -638,7 +671,8 @@ EXAMPLES
638
671
  $ apollo feature get-id -i abc...zyz def...foo
639
672
  ```
640
673
 
641
- _See code: [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/get-id.ts)_
674
+ _See code:
675
+ [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/get-id.ts)_
642
676
 
643
677
  ## `apollo feature import`
644
678
 
@@ -651,7 +685,7 @@ USAGE
651
685
  FLAGS
652
686
  -a, --assembly=<value> (required) Import into this assembly name or assembly ID
653
687
  -d, --delete-existing Delete existing features before importing
654
- -i, --input-file=<value> (required) Input gff or gtf file
688
+ -i, --input-file=<value> (required) Input gff file
655
689
  --config-file=<value> Use this config file (mostly for testing)
656
690
  --profile=<value> Use credentials from this profile
657
691
 
@@ -666,7 +700,8 @@ EXAMPLES
666
700
  $ apollo feature import -d -i features.gff3 -a myAssembly
667
701
  ```
668
702
 
669
- _See code: [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/import.ts)_
703
+ _See code:
704
+ [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/import.ts)_
670
705
 
671
706
  ## `apollo feature search`
672
707
 
@@ -677,8 +712,8 @@ USAGE
677
712
  $ apollo feature search -t <value> [--profile <value>] [--config-file <value>] [-a <value>]
678
713
 
679
714
  FLAGS
680
- -a, --assembly=<value>... Assembly names or IDs to search; use "-" to read it from stdin. If omitted
681
- search all assemblies
715
+ -a, --assembly=<value>... Assembly names or IDs to search; use "-" to read it from stdin. If omitted search all
716
+ assemblies
682
717
  -t, --text=<value> (required) Search for this text query
683
718
  --config-file=<value> Use this config file (mostly for testing)
684
719
  --profile=<value> Use credentials from this profile
@@ -702,8 +737,7 @@ DESCRIPTION
702
737
 
703
738
  chr1 example SNP 10 30 0.987 . . "someKey=Fingerprint BAC with reads"
704
739
 
705
- Queries "bac" or "mRNA" return the feature. Instead these queries will NOT
706
- match:
740
+ Queries "bac" or "mRNA" return the feature. Instead these queries will NOT match:
707
741
 
708
742
  - "someKey"
709
743
  - "with"
@@ -717,7 +751,125 @@ EXAMPLES
717
751
  $ apollo feature search -a mm9 mm10 -t bac
718
752
  ```
719
753
 
720
- _See code: [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/feature/search.ts)_
754
+ _See code:
755
+ [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/search.ts)_
756
+
757
+ ## `apollo file delete`
758
+
759
+ Delete files from the Apollo server
760
+
761
+ ```
762
+ USAGE
763
+ $ apollo file delete [--profile <value>] [--config-file <value>] [-i <value>]
764
+
765
+ FLAGS
766
+ -i, --file-id=<value>... [default: -] IDs of the files to delete
767
+ --config-file=<value> Use this config file (mostly for testing)
768
+ --profile=<value> Use credentials from this profile
769
+
770
+ DESCRIPTION
771
+ Delete files from the Apollo server
772
+
773
+ Deleted files are printed to stdout. See also `apollo file get` to list the files on the server
774
+
775
+ EXAMPLES
776
+ Delete file multiple files:
777
+
778
+ $ apollo file delete -i 123...abc xyz...789
779
+ ```
780
+
781
+ _See code:
782
+ [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/delete.ts)_
783
+
784
+ ## `apollo file download`
785
+
786
+ Download a file from the Apollo server
787
+
788
+ ```
789
+ USAGE
790
+ $ apollo file download [--profile <value>] [--config-file <value>] [-i <value>] [-o <value>]
791
+
792
+ FLAGS
793
+ -i, --file-id=<value> [default: -] ID of the file to download
794
+ -o, --output=<value> Write output to this file or "-" for stdout. Default to the name of the uploaded file.
795
+ --config-file=<value> Use this config file (mostly for testing)
796
+ --profile=<value> Use credentials from this profile
797
+
798
+ DESCRIPTION
799
+ Download a file from the Apollo server
800
+
801
+ See also `apollo file get` to list the files on the server
802
+
803
+ EXAMPLES
804
+ Download file with id xyz
805
+
806
+ $ apollo file download -i xyz -o genome.fa
807
+ ```
808
+
809
+ _See code:
810
+ [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/download.ts)_
811
+
812
+ ## `apollo file get`
813
+
814
+ Get list of files uploaded to the Apollo server
815
+
816
+ ```
817
+ USAGE
818
+ $ apollo file get [--profile <value>] [--config-file <value>] [-i <value>]
819
+
820
+ FLAGS
821
+ -i, --file-id=<value>... Get files matching this IDs
822
+ --config-file=<value> Use this config file (mostly for testing)
823
+ --profile=<value> Use credentials from this profile
824
+
825
+ DESCRIPTION
826
+ Get list of files uploaded to the Apollo server
827
+
828
+ Print to stdout the list of files in json format
829
+
830
+ EXAMPLES
831
+ Get files by id:
832
+
833
+ $ apollo file get -i xyz abc
834
+ ```
835
+
836
+ _See code:
837
+ [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/get.ts)_
838
+
839
+ ## `apollo file upload`
840
+
841
+ Upload a local file to the Apollo server
842
+
843
+ ```
844
+ USAGE
845
+ $ apollo file upload -i <value> [--profile <value>] [--config-file <value>] [-t
846
+ text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi] [-z | -d]
847
+
848
+ FLAGS
849
+ -d, --decompressed Override autodetection and instruct that input is decompressed
850
+ -i, --input-file=<value> (required) Local file to upload
851
+ -t, --type=<option> Set file type or autodetected it if not set.
852
+ NB: There is no check for whether the file complies to this type
853
+ <options: text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi>
854
+ -z, --gzip Override autodetection and instruct that input is gzip compressed
855
+ --config-file=<value> Use this config file (mostly for testing)
856
+ --profile=<value> Use credentials from this profile
857
+
858
+ DESCRIPTION
859
+ Upload a local file to the Apollo server
860
+
861
+ This command only uploads a file and returns the corresponding file id.
862
+ To add an assembly based on this file or to upload & add an assembly in a single pass see `apollo assembly
863
+ add-from-fasta` and `add-from-gff`
864
+
865
+ EXAMPLES
866
+ Upload local file, type auto-detected:
867
+
868
+ $ apollo file upload -i genome.fa > file.json
869
+ ```
870
+
871
+ _See code:
872
+ [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/upload.ts)_
721
873
 
722
874
  ## `apollo help [COMMANDS]`
723
875
 
@@ -737,7 +889,63 @@ DESCRIPTION
737
889
  Display help for apollo.
738
890
  ```
739
891
 
740
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.8/src/commands/help.ts)_
892
+ _See code:
893
+ [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.8/src/commands/help.ts)_
894
+
895
+ ## `apollo jbrowse get-config`
896
+
897
+ Get JBrowse configuration from Apollo
898
+
899
+ ```
900
+ USAGE
901
+ $ apollo jbrowse get-config [--profile <value>] [--config-file <value>]
902
+
903
+ FLAGS
904
+ --config-file=<value> Use this config file (mostly for testing)
905
+ --profile=<value> Use credentials from this profile
906
+
907
+ DESCRIPTION
908
+ Get JBrowse configuration from Apollo
909
+
910
+ Print to stdout the JBrowse configuration from Apollo in JSON format
911
+
912
+ EXAMPLES
913
+ Get JBrowse configuration:
914
+
915
+ $ apollo jbrowse get-config > config.json
916
+ ```
917
+
918
+ _See code:
919
+ [src/commands/jbrowse/get-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/jbrowse/get-config.ts)_
920
+
921
+ ## `apollo jbrowse set-config INPUTFILE`
922
+
923
+ Set JBrowse configuration
924
+
925
+ ```
926
+ USAGE
927
+ $ apollo jbrowse set-config INPUTFILE [--profile <value>] [--config-file <value>]
928
+
929
+ ARGUMENTS
930
+ INPUTFILE JBrowse configuration file
931
+
932
+ FLAGS
933
+ --config-file=<value> Use this config file (mostly for testing)
934
+ --profile=<value> Use credentials from this profile
935
+
936
+ DESCRIPTION
937
+ Set JBrowse configuration
938
+
939
+ Set JBrowse configuration in Apollo collaboration server
940
+
941
+ EXAMPLES
942
+ Add JBrowse configuration:
943
+
944
+ $ apollo jbrowse set-config config.json
945
+ ```
946
+
947
+ _See code:
948
+ [src/commands/jbrowse/set-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/jbrowse/set-config.ts)_
741
949
 
742
950
  ## `apollo login`
743
951
 
@@ -761,14 +969,12 @@ FLAGS
761
969
  DESCRIPTION
762
970
  Login to Apollo
763
971
 
764
- Use the provided credentials to obtain and save the token to access Apollo. Once
765
- the token for the given profile has been saved in the configuration file, users
766
- do not normally need to execute this command again unless the token has expired.
767
- To setup a new profile use "apollo config"
972
+ Use the provided credentials to obtain and save the token to access Apollo. Once the token for the given profile has
973
+ been saved in the configuration file, users do not normally need to execute this command again unless the token has
974
+ expired. To setup a new profile use "apollo config"
768
975
 
769
976
  EXAMPLES
770
- The most basic and probably most typical usage is to login using the default
771
- profile in configuration file:
977
+ The most basic and probably most typical usage is to login using the default profile in configuration file:
772
978
 
773
979
  $ apollo login
774
980
 
@@ -777,7 +983,8 @@ EXAMPLES
777
983
  $ apollo login --profile my-profile
778
984
  ```
779
985
 
780
- _See code: [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/login.ts)_
986
+ _See code:
987
+ [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/login.ts)_
781
988
 
782
989
  ## `apollo logout`
783
990
 
@@ -806,7 +1013,37 @@ EXAMPLES
806
1013
  $ apollo logout --profile my-profile
807
1014
  ```
808
1015
 
809
- _See code: [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/logout.ts)_
1016
+ _See code:
1017
+ [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/logout.ts)_
1018
+
1019
+ ## `apollo refseq add-alias`
1020
+
1021
+ Add reference name aliases from a file
1022
+
1023
+ ```
1024
+ USAGE
1025
+ $ apollo refseq add-alias -i <value> -a <value> [--profile <value>] [--config-file <value>]
1026
+
1027
+ FLAGS
1028
+ -a, --assembly=<value> (required) Name for this assembly.
1029
+ -i, --input-file=<value> (required) Input refname alias file
1030
+ --config-file=<value> Use this config file (mostly for testing)
1031
+ --profile=<value> Use credentials from this profile
1032
+
1033
+ DESCRIPTION
1034
+ Add reference name aliases from a file
1035
+
1036
+ Reference name aliasing is a process to make chromosomes that are named slightly differently but which refer to the
1037
+ same thing render properly. This command reads a file with reference name aliases and adds them to the database.
1038
+
1039
+ EXAMPLES
1040
+ Add reference name aliases:
1041
+
1042
+ $ apollo refseq add-alias -i alias.txt -a myAssembly
1043
+ ```
1044
+
1045
+ _See code:
1046
+ [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
810
1047
 
811
1048
  ## `apollo refseq get`
812
1049
 
@@ -824,9 +1061,8 @@ FLAGS
824
1061
  DESCRIPTION
825
1062
  Get reference sequences
826
1063
 
827
- Output the reference sequences in one or more assemblies in json format. This
828
- command returns the sequence characteristics (e.g., name, ID, etc), not the DNA
829
- sequences. Use `assembly sequence` for that.
1064
+ Output the reference sequences in one or more assemblies in json format. This command returns the sequence
1065
+ characteristics (e.g., name, ID, etc), not the DNA sequences. Use `assembly sequence` for that.
830
1066
 
831
1067
  EXAMPLES
832
1068
  All sequences in the database:
@@ -838,7 +1074,8 @@ EXAMPLES
838
1074
  $ apollo refseq get -a mm9 mm10
839
1075
  ```
840
1076
 
841
- _See code: [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/refseq/get.ts)_
1077
+ _See code:
1078
+ [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/refseq/get.ts)_
842
1079
 
843
1080
  ## `apollo status`
844
1081
 
@@ -855,12 +1092,12 @@ FLAGS
855
1092
  DESCRIPTION
856
1093
  View authentication status
857
1094
 
858
- This command returns "<profile>: Logged in" if the selected profile has an
859
- access token and "<profile>: Logged out" otherwise. Note that this command does
860
- not check the validity of the access token.
1095
+ This command returns "<profile>: Logged in" if the selected profile has an access token and "<profile>: Logged out"
1096
+ otherwise.Note that this command does not check the validity of the access token.
861
1097
  ```
862
1098
 
863
- _See code: [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/status.ts)_
1099
+ _See code:
1100
+ [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/status.ts)_
864
1101
 
865
1102
  ## `apollo user get`
866
1103
 
@@ -895,5 +1132,7 @@ EXAMPLES
895
1132
  $ apollo user get | jq '.[] | select(.createdAt > "2024-03-18")'
896
1133
  ```
897
1134
 
898
- _See code: [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.18/packages/apollo-cli/src/commands/user/get.ts)_
1135
+ _See code:
1136
+ [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/user/get.ts)_
1137
+
899
1138
  <!-- commandsstop -->