@apollo-annotation/cli 0.1.19 → 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 (52) hide show
  1. package/README.md +283 -106
  2. package/dist/baseCommand.d.ts +1 -1
  3. package/dist/baseCommand.js +3 -4
  4. package/dist/commands/assembly/add-from-fasta.d.ts +23 -0
  5. package/dist/commands/assembly/add-from-fasta.js +165 -0
  6. package/dist/commands/assembly/{add-gff.d.ts → add-from-gff.d.ts} +5 -3
  7. package/dist/commands/assembly/{add-gff.js → add-from-gff.js} +20 -21
  8. package/dist/commands/assembly/check.js +9 -9
  9. package/dist/commands/assembly/delete.js +4 -4
  10. package/dist/commands/assembly/get.js +4 -4
  11. package/dist/commands/assembly/sequence.js +4 -4
  12. package/dist/commands/change/get.js +7 -7
  13. package/dist/commands/config.js +3 -4
  14. package/dist/commands/feature/add-child.js +6 -5
  15. package/dist/commands/feature/check.js +6 -6
  16. package/dist/commands/feature/copy.js +5 -4
  17. package/dist/commands/feature/delete.js +4 -4
  18. package/dist/commands/feature/edit-attribute.js +6 -5
  19. package/dist/commands/feature/edit-coords.js +5 -5
  20. package/dist/commands/feature/edit-type.js +5 -5
  21. package/dist/commands/feature/edit.js +5 -5
  22. package/dist/commands/feature/get-id.js +5 -5
  23. package/dist/commands/feature/get.js +3 -3
  24. package/dist/commands/feature/import.d.ts +2 -2
  25. package/dist/commands/feature/import.js +6 -6
  26. package/dist/commands/feature/search.js +6 -6
  27. package/dist/commands/file/delete.d.ts +13 -0
  28. package/dist/commands/file/delete.js +58 -0
  29. package/dist/commands/file/download.d.ts +14 -0
  30. package/dist/commands/file/download.js +45 -0
  31. package/dist/commands/file/get.d.ts +13 -0
  32. package/dist/commands/file/get.js +38 -0
  33. package/dist/commands/file/upload.d.ts +16 -0
  34. package/dist/commands/file/upload.js +88 -0
  35. package/dist/commands/jbrowse/get-config.d.ts +10 -0
  36. package/dist/commands/jbrowse/get-config.js +21 -0
  37. package/dist/commands/jbrowse/set-config.d.ts +13 -0
  38. package/dist/commands/jbrowse/set-config.js +51 -0
  39. package/dist/commands/login.js +11 -15
  40. package/dist/commands/logout.js +2 -2
  41. package/dist/commands/refseq/add-alias.js +3 -3
  42. package/dist/commands/refseq/get.js +8 -8
  43. package/dist/commands/status.js +4 -3
  44. package/dist/commands/user/get.js +3 -3
  45. package/dist/fileCommand.d.ts +5 -0
  46. package/dist/fileCommand.js +76 -0
  47. package/dist/utils.d.ts +20 -9
  48. package/dist/utils.js +25 -103
  49. package/oclif.manifest.json +445 -69
  50. package/package.json +50 -43
  51. package/dist/commands/assembly/add-fasta.d.ts +0 -15
  52. package/dist/commands/assembly/add-fasta.js +0 -87
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @apollo-annotation/cli
16
16
  $ apollo COMMAND
17
17
  running command...
18
18
  $ apollo (--version)
19
- @apollo-annotation/cli/0.1.19 linux-x64 node-v20.14.0
19
+ @apollo-annotation/cli/0.1.20 linux-x64 node-v18.20.4
20
20
  $ apollo --help [COMMAND]
21
21
  USAGE
22
22
  $ apollo COMMAND
@@ -29,8 +29,8 @@ USAGE
29
29
 
30
30
  <!-- commands -->
31
31
 
32
- - [`apollo assembly add-fasta`](#apollo-assembly-add-fasta)
33
- - [`apollo assembly add-gff`](#apollo-assembly-add-gff)
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
34
  - [`apollo assembly check`](#apollo-assembly-check)
35
35
  - [`apollo assembly delete`](#apollo-assembly-delete)
36
36
  - [`apollo assembly get`](#apollo-assembly-get)
@@ -49,7 +49,13 @@ USAGE
49
49
  - [`apollo feature get-id`](#apollo-feature-get-id)
50
50
  - [`apollo feature import`](#apollo-feature-import)
51
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)
52
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)
53
59
  - [`apollo login`](#apollo-login)
54
60
  - [`apollo logout`](#apollo-logout)
55
61
  - [`apollo refseq add-alias`](#apollo-refseq-add-alias)
@@ -57,51 +63,68 @@ USAGE
57
63
  - [`apollo status`](#apollo-status)
58
64
  - [`apollo user get`](#apollo-user-get)
59
65
 
60
- ## `apollo assembly add-fasta`
66
+ ## `apollo assembly add-from-fasta INPUT`
61
67
 
62
- Add new assembly from local or external fasta file
68
+ Add a new assembly from fasta input
63
69
 
64
70
  ```
65
71
  USAGE
66
- $ apollo assembly add-fasta -i <value> [--profile <value>] [--config-file <value>] [-a <value>] [-x <value>] [-f]
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
67
77
 
68
78
  FLAGS
69
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
70
81
  -f, --force Delete existing assembly, if it exists
71
- -i, --input-file=<value> (required) Input fasta file
72
- -x, --index=<value> URL of the index. Required if input is an external source and ignored if input is a local
73
- 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
74
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
75
91
  --profile=<value> Use credentials from this profile
76
92
 
77
93
  DESCRIPTION
78
- 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
79
100
 
80
101
  EXAMPLES
81
102
  From local file:
82
103
 
83
- $ apollo assembly add-fasta -i genome.fa -a myAssembly
104
+ $ apollo assembly add-from-fasta genome.fa -a myAssembly
84
105
 
85
106
  From external source we also need the URL of the index:
86
107
 
87
- $ 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
88
109
  ```
89
110
 
90
111
  _See code:
91
- [src/commands/assembly/add-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/add-fasta.ts)_
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)_
92
113
 
93
- ## `apollo assembly add-gff`
114
+ ## `apollo assembly add-from-gff INPUT-FILE`
94
115
 
95
116
  Add new assembly from gff or gft file
96
117
 
97
118
  ```
98
119
  USAGE
99
- $ 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
100
124
 
101
125
  FLAGS
102
126
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
103
127
  -f, --force Delete existing assembly, if it exists
104
- -i, --input-file=<value> (required) Input gff or gtf file
105
128
  -o, --omit-features Do not import features, only upload the sequences
106
129
  --config-file=<value> Use this config file (mostly for testing)
107
130
  --profile=<value> Use credentials from this profile
@@ -109,21 +132,20 @@ FLAGS
109
132
  DESCRIPTION
110
133
  Add new assembly from gff or gft file
111
134
 
112
- The gff file is expected to contain sequences as per gff specifications.
113
- 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.
114
136
 
115
137
  EXAMPLES
116
138
  Import sequences and features:
117
139
 
118
- $ apollo assembly add-gff -i genome.gff -a myAssembly
140
+ $ apollo assembly add-from-gff -i genome.gff -a myAssembly
119
141
 
120
142
  Import sequences only:
121
143
 
122
- $ apollo assembly add-gff -i genome.gff -a myAssembly -o
144
+ $ apollo assembly add-from-gff genome.gff -a myAssembly -o
123
145
  ```
124
146
 
125
147
  _See code:
126
- [src/commands/assembly/add-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/add-gff.ts)_
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)_
127
149
 
128
150
  ## `apollo assembly check`
129
151
 
@@ -143,9 +165,8 @@ FLAGS
143
165
  DESCRIPTION
144
166
  Add, view, or delete checks to assembly
145
167
 
146
- Manage checks, i.e. the rules ensuring features in an assembly are plausible.
147
- This command only sets the checks to apply, to retrieve features flagged by
148
- 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`.
149
170
 
150
171
  EXAMPLES
151
172
  View available check types:
@@ -166,7 +187,7 @@ EXAMPLES
166
187
  ```
167
188
 
168
189
  _See code:
169
- [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/check.ts)_
190
+ [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/check.ts)_
170
191
 
171
192
  ## `apollo assembly delete`
172
193
 
@@ -194,7 +215,7 @@ EXAMPLES
194
215
  ```
195
216
 
196
217
  _See code:
197
- [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/delete.ts)_
218
+ [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/delete.ts)_
198
219
 
199
220
  ## `apollo assembly get`
200
221
 
@@ -216,7 +237,7 @@ DESCRIPTION
216
237
  ```
217
238
 
218
239
  _See code:
219
- [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/get.ts)_
240
+ [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/get.ts)_
220
241
 
221
242
  ## `apollo assembly sequence`
222
243
 
@@ -251,7 +272,7 @@ EXAMPLES
251
272
  ```
252
273
 
253
274
  _See code:
254
- [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/sequence.ts)_
275
+ [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/sequence.ts)_
255
276
 
256
277
  ## `apollo change get`
257
278
 
@@ -269,14 +290,13 @@ FLAGS
269
290
  DESCRIPTION
270
291
  Get list of changes
271
292
 
272
- Return the change log in json format. Note that when an assembly is deleted the
273
- link between common name and ID is lost (it can still be recovered by inspecting
274
- the change log but at present this task is left to the user). In such cases you
275
- 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.
276
296
  ```
277
297
 
278
298
  _See code:
279
- [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/change/get.ts)_
299
+ [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/change/get.ts)_
280
300
 
281
301
  ## `apollo config [KEY] [VALUE]`
282
302
 
@@ -298,15 +318,14 @@ FLAGS
298
318
  DESCRIPTION
299
319
  Get or set apollo configuration options
300
320
 
301
- Use this command to create or edit a user profile with credentials to access
302
- Apollo. Configuration options are:
321
+ Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:
303
322
 
304
323
  - address:
305
324
  Address and port e.g http://localhost:3999
306
325
 
307
326
  - accessType:
308
- How to access Apollo. accessType is typically one of: google, microsoft, guest,
309
- 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
310
329
 
311
330
  - accessToken:
312
331
  Access token. Usually inserted by `apollo login`
@@ -332,7 +351,7 @@ EXAMPLES
332
351
  ```
333
352
 
334
353
  _See code:
335
- [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/config.ts)_
354
+ [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/config.ts)_
336
355
 
337
356
  ## `apollo feature add-child`
338
357
 
@@ -353,17 +372,17 @@ FLAGS
353
372
  DESCRIPTION
354
373
  Add a child feature (e.g. add an exon to an mRNA)
355
374
 
356
- See the other commands under `apollo feature` to retrive the parent ID of
357
- 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.
358
377
 
359
378
  EXAMPLES
360
379
  Add an exon at genomic coordinates 10..20 to this feature ID:
361
380
 
362
- $ 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
363
382
  ```
364
383
 
365
384
  _See code:
366
- [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/add-child.ts)_
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)_
367
386
 
368
387
  ## `apollo feature check`
369
388
 
@@ -382,9 +401,8 @@ FLAGS
382
401
  DESCRIPTION
383
402
  Get check results
384
403
 
385
- Use this command to view which features fail checks along with the reason for
386
- failing. Use `apollo assembly check` for managing which checks should be applied
387
- 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
388
406
 
389
407
  EXAMPLES
390
408
  Get all check results in the database:
@@ -397,7 +415,7 @@ EXAMPLES
397
415
  ```
398
416
 
399
417
  _See code:
400
- [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/check.ts)_
418
+ [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/check.ts)_
401
419
 
402
420
  ## `apollo feature copy`
403
421
 
@@ -418,9 +436,8 @@ FLAGS
418
436
  DESCRIPTION
419
437
  Copy a feature to another location
420
438
 
421
- The feature may be copied to the same or to a different assembly. he destination
422
- reference sequence may be selected by name only if unique in the database or by
423
- 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.
424
441
 
425
442
  EXAMPLES
426
443
  Copy this feature ID to chr1:100 in assembly hg38:
@@ -429,7 +446,7 @@ EXAMPLES
429
446
  ```
430
447
 
431
448
  _See code:
432
- [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/copy.ts)_
449
+ [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/copy.ts)_
433
450
 
434
451
  ## `apollo feature delete`
435
452
 
@@ -449,12 +466,11 @@ FLAGS
449
466
  DESCRIPTION
450
467
  Delete one or more features by ID
451
468
 
452
- Note that deleting a child feature after deleting its parent will result in an
453
- 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.
454
470
  ```
455
471
 
456
472
  _See code:
457
- [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/delete.ts)_
473
+ [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/delete.ts)_
458
474
 
459
475
  ## `apollo feature edit`
460
476
 
@@ -472,12 +488,11 @@ FLAGS
472
488
  DESCRIPTION
473
489
  Edit features using an appropiate json input
474
490
 
475
- Edit a feature by submitting a json input with all the required attributes for
476
- Apollo to process it. This is a very low level command which most users probably
477
- 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.
478
493
 
479
- Input may be a json string or a json file and it may be an array of changes.
480
- 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:
481
496
 
482
497
  {
483
498
  "typeName": "TypeChange",
@@ -497,7 +512,7 @@ EXAMPLES
497
512
  ```
498
513
 
499
514
  _See code:
500
- [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit.ts)_
515
+ [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/edit.ts)_
501
516
 
502
517
  ## `apollo feature edit-attribute`
503
518
 
@@ -519,9 +534,8 @@ FLAGS
519
534
  DESCRIPTION
520
535
  Add, edit, or view a feature attribute
521
536
 
522
- Be aware that there is no checking whether attributes names and values are
523
- valid. For example, you can create non-unique ID attributes or you can set gene
524
- 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
525
539
 
526
540
  EXAMPLES
527
541
  Add attribute "domains" with a list of values:
@@ -538,7 +552,7 @@ EXAMPLES
538
552
  ```
539
553
 
540
554
  _See code:
541
- [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
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)_
542
556
 
543
557
  ## `apollo feature edit-coords`
544
558
 
@@ -558,9 +572,8 @@ FLAGS
558
572
  DESCRIPTION
559
573
  Edit feature start and/or end coordinates
560
574
 
561
- If editing a child feature that new coordinates must be within the parent's
562
- coordinates. To get the identifier of the feature to edit consider using `apollo
563
- 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`
564
577
 
565
578
  EXAMPLES
566
579
  Edit start and end:
@@ -573,7 +586,7 @@ EXAMPLES
573
586
  ```
574
587
 
575
588
  _See code:
576
- [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
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)_
577
590
 
578
591
  ## `apollo feature edit-type`
579
592
 
@@ -592,12 +605,12 @@ FLAGS
592
605
  DESCRIPTION
593
606
  Edit or view feature type
594
607
 
595
- Feature type is column 3 in gff format. It must be a valid sequence ontology
596
- 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.
597
610
  ```
598
611
 
599
612
  _See code:
600
- [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-type.ts)_
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)_
601
614
 
602
615
  ## `apollo feature get`
603
616
 
@@ -624,14 +637,14 @@ EXAMPLES
624
637
 
625
638
  $ apollo feature get -a myAssembly
626
639
 
627
- Get features intersecting chr1:1..1000. You can omit the assembly name if there
628
- 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:
629
642
 
630
643
  $ apollo feature get -a myAssembly -r chr1 -s 1 -e 1000
631
644
  ```
632
645
 
633
646
  _See code:
634
- [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/get.ts)_
647
+ [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/get.ts)_
635
648
 
636
649
  ## `apollo feature get-id`
637
650
 
@@ -642,8 +655,7 @@ USAGE
642
655
  $ apollo feature get-id [--profile <value>] [--config-file <value>] [-i <value>]
643
656
 
644
657
  FLAGS
645
- -i, --feature-id=<value>... [default: -] Retrieves feature with these IDs. Use
646
- "-" 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
647
659
  line)
648
660
  --config-file=<value> Use this config file (mostly for testing)
649
661
  --profile=<value> Use credentials from this profile
@@ -651,8 +663,7 @@ FLAGS
651
663
  DESCRIPTION
652
664
  Get features given their identifiers
653
665
 
654
- Invalid identifiers or identifiers not found in the database will be silently
655
- ignored
666
+ Invalid identifiers or identifiers not found in the database will be silently ignored
656
667
 
657
668
  EXAMPLES
658
669
  Get features for these identifiers:
@@ -661,7 +672,7 @@ EXAMPLES
661
672
  ```
662
673
 
663
674
  _See code:
664
- [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/get-id.ts)_
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)_
665
676
 
666
677
  ## `apollo feature import`
667
678
 
@@ -674,7 +685,7 @@ USAGE
674
685
  FLAGS
675
686
  -a, --assembly=<value> (required) Import into this assembly name or assembly ID
676
687
  -d, --delete-existing Delete existing features before importing
677
- -i, --input-file=<value> (required) Input gff or gtf file
688
+ -i, --input-file=<value> (required) Input gff file
678
689
  --config-file=<value> Use this config file (mostly for testing)
679
690
  --profile=<value> Use credentials from this profile
680
691
 
@@ -690,7 +701,7 @@ EXAMPLES
690
701
  ```
691
702
 
692
703
  _See code:
693
- [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/import.ts)_
704
+ [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/feature/import.ts)_
694
705
 
695
706
  ## `apollo feature search`
696
707
 
@@ -701,8 +712,8 @@ USAGE
701
712
  $ apollo feature search -t <value> [--profile <value>] [--config-file <value>] [-a <value>]
702
713
 
703
714
  FLAGS
704
- -a, --assembly=<value>... Assembly names or IDs to search; use "-" to read it from stdin. If omitted
705
- 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
706
717
  -t, --text=<value> (required) Search for this text query
707
718
  --config-file=<value> Use this config file (mostly for testing)
708
719
  --profile=<value> Use credentials from this profile
@@ -726,8 +737,7 @@ DESCRIPTION
726
737
 
727
738
  chr1 example SNP 10 30 0.987 . . "someKey=Fingerprint BAC with reads"
728
739
 
729
- Queries "bac" or "mRNA" return the feature. Instead these queries will NOT
730
- match:
740
+ Queries "bac" or "mRNA" return the feature. Instead these queries will NOT match:
731
741
 
732
742
  - "someKey"
733
743
  - "with"
@@ -742,7 +752,124 @@ EXAMPLES
742
752
  ```
743
753
 
744
754
  _See code:
745
- [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/search.ts)_
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)_
746
873
 
747
874
  ## `apollo help [COMMANDS]`
748
875
 
@@ -765,6 +892,61 @@ DESCRIPTION
765
892
  _See code:
766
893
  [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.8/src/commands/help.ts)_
767
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)_
949
+
768
950
  ## `apollo login`
769
951
 
770
952
  Login to Apollo
@@ -787,14 +969,12 @@ FLAGS
787
969
  DESCRIPTION
788
970
  Login to Apollo
789
971
 
790
- Use the provided credentials to obtain and save the token to access Apollo. Once
791
- the token for the given profile has been saved in the configuration file, users
792
- do not normally need to execute this command again unless the token has expired.
793
- 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"
794
975
 
795
976
  EXAMPLES
796
- The most basic and probably most typical usage is to login using the default
797
- profile in configuration file:
977
+ The most basic and probably most typical usage is to login using the default profile in configuration file:
798
978
 
799
979
  $ apollo login
800
980
 
@@ -804,7 +984,7 @@ EXAMPLES
804
984
  ```
805
985
 
806
986
  _See code:
807
- [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/login.ts)_
987
+ [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/login.ts)_
808
988
 
809
989
  ## `apollo logout`
810
990
 
@@ -834,7 +1014,7 @@ EXAMPLES
834
1014
  ```
835
1015
 
836
1016
  _See code:
837
- [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/logout.ts)_
1017
+ [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/logout.ts)_
838
1018
 
839
1019
  ## `apollo refseq add-alias`
840
1020
 
@@ -853,9 +1033,8 @@ FLAGS
853
1033
  DESCRIPTION
854
1034
  Add reference name aliases from a file
855
1035
 
856
- Reference name aliasing is a process to make chromosomes that are named slightly
857
- differently but which refer to the same thing render properly. This command
858
- reads a file with reference name aliases and adds them to the database.
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.
859
1038
 
860
1039
  EXAMPLES
861
1040
  Add reference name aliases:
@@ -864,7 +1043,7 @@ EXAMPLES
864
1043
  ```
865
1044
 
866
1045
  _See code:
867
- [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
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)_
868
1047
 
869
1048
  ## `apollo refseq get`
870
1049
 
@@ -882,9 +1061,8 @@ FLAGS
882
1061
  DESCRIPTION
883
1062
  Get reference sequences
884
1063
 
885
- Output the reference sequences in one or more assemblies in json format. This
886
- command returns the sequence characteristics (e.g., name, ID, etc), not the DNA
887
- 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.
888
1066
 
889
1067
  EXAMPLES
890
1068
  All sequences in the database:
@@ -897,7 +1075,7 @@ EXAMPLES
897
1075
  ```
898
1076
 
899
1077
  _See code:
900
- [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/refseq/get.ts)_
1078
+ [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/refseq/get.ts)_
901
1079
 
902
1080
  ## `apollo status`
903
1081
 
@@ -914,13 +1092,12 @@ FLAGS
914
1092
  DESCRIPTION
915
1093
  View authentication status
916
1094
 
917
- This command returns "<profile>: Logged in" if the selected profile has an
918
- access token and "<profile>: Logged out" otherwise. Note that this command does
919
- 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.
920
1097
  ```
921
1098
 
922
1099
  _See code:
923
- [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/status.ts)_
1100
+ [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/status.ts)_
924
1101
 
925
1102
  ## `apollo user get`
926
1103
 
@@ -956,6 +1133,6 @@ EXAMPLES
956
1133
  ```
957
1134
 
958
1135
  _See code:
959
- [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/user/get.ts)_
1136
+ [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/user/get.ts)_
960
1137
 
961
1138
  <!-- commandsstop -->