@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
@@ -12,7 +12,7 @@
12
12
  "name": "value"
13
13
  }
14
14
  },
15
- "description": "Use this command to create or edit a user profile with credentials to access\nApollo. Configuration options are:\n\n - address:\nAddress and port e.g http://localhost:3999\n\n- accessType:\nHow to access Apollo. accessType is typically one of: google, microsoft, guest,\nroot. Allowed types depend on your Apollo setup\n\n- accessToken:\nAccess token. Usually inserted by `apollo login`\n\n- rootCredentials.username:\nUsername of root account. Only set this for \"root\" access type\n\n- rootCredentials.password:\nPassword for root account. Only set this for \"root\" access type",
15
+ "description": "Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:\n\n - address:\nAddress and port e.g http://localhost:3999\n\n- accessType:\nHow to access Apollo. accessType is typically one of: google, microsoft, guest, root. Allowed types depend on your Apollo setup\n\n- accessToken:\nAccess token. Usually inserted by `apollo login`\n\n- rootCredentials.username:\nUsername of root account. Only set this for \"root\" access type\n\n- rootCredentials.password:\nPassword for root account. Only set this for \"root\" access type",
16
16
  "examples": [
17
17
  {
18
18
  "description": "Interactive setup:",
@@ -69,10 +69,10 @@
69
69
  "login": {
70
70
  "aliases": [],
71
71
  "args": {},
72
- "description": "Use the provided credentials to obtain and save the token to access Apollo. Once\nthe token for the given profile has been saved in the configuration file, users\ndo not normally need to execute this command again unless the token has expired.\nTo setup a new profile use \"apollo config\"",
72
+ "description": "Use the provided credentials to obtain and save the token to access Apollo. Once the token for the given profile has been saved in the configuration file, users do not normally need to execute this command again unless the token has expired. To setup a new profile use \"apollo config\"",
73
73
  "examples": [
74
74
  {
75
- "description": "The most basic and probably most typical usage is to login using the default\nprofile in configuration file:",
75
+ "description": "The most basic and probably most typical usage is to login using the default profile in configuration file:",
76
76
  "command": "<%= config.bin %> <%= command.id %>"
77
77
  },
78
78
  {
@@ -203,7 +203,7 @@
203
203
  "status": {
204
204
  "aliases": [],
205
205
  "args": {},
206
- "description": "This command returns \"<profile>: Logged in\" if the selected profile has an\naccess token and \"<profile>: Logged out\" otherwise. Note that this command does\nnot check the validity of the access token.",
206
+ "description": "This command returns \"<profile>: Logged in\" if the selected profile has an access token and \"<profile>: Logged out\" otherwise.Note that this command does not check the validity of the access token.",
207
207
  "flags": {
208
208
  "profile": {
209
209
  "description": "Use credentials from this profile",
@@ -236,18 +236,24 @@
236
236
  "status.js"
237
237
  ]
238
238
  },
239
- "assembly:add-fasta": {
239
+ "assembly:add-from-fasta": {
240
240
  "aliases": [],
241
- "args": {},
242
- "description": "Add new assembly from local or external fasta file",
241
+ "args": {
242
+ "input": {
243
+ "description": "Input fasta file, local or remote, or id of a previously uploaded file",
244
+ "name": "input",
245
+ "required": true
246
+ }
247
+ },
248
+ "description": "Add new assembly. The input fasta may be:\n * A local file \n * An external fasta file\n * The id of a file previously uploaded to Apollo",
243
249
  "examples": [
244
250
  {
245
251
  "description": "From local file:",
246
- "command": "<%= config.bin %> <%= command.id %> -i genome.fa -a myAssembly"
252
+ "command": "<%= config.bin %> <%= command.id %> genome.fa -a myAssembly"
247
253
  },
248
254
  {
249
255
  "description": "From external source we also need the URL of the index:",
250
- "command": "<%= config.bin %> <%= command.id %> -i https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly"
256
+ "command": "<%= config.bin %> <%= command.id %> https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly"
251
257
  }
252
258
  ],
253
259
  "flags": {
@@ -265,15 +271,6 @@
265
271
  "multiple": false,
266
272
  "type": "option"
267
273
  },
268
- "input-file": {
269
- "char": "i",
270
- "description": "Input fasta file",
271
- "name": "input-file",
272
- "required": true,
273
- "hasDynamicHelp": false,
274
- "multiple": false,
275
- "type": "option"
276
- },
277
274
  "assembly": {
278
275
  "char": "a",
279
276
  "description": "Name for this assembly. Use the file name if omitted",
@@ -284,7 +281,7 @@
284
281
  },
285
282
  "index": {
286
283
  "char": "x",
287
- "description": "URL of the index. Required if input is an external source and ignored if input is a local file",
284
+ "description": "URL of the index. Required if input is an external source",
288
285
  "name": "index",
289
286
  "hasDynamicHelp": false,
290
287
  "multiple": false,
@@ -296,28 +293,75 @@
296
293
  "name": "force",
297
294
  "allowNo": false,
298
295
  "type": "boolean"
296
+ },
297
+ "not-editable": {
298
+ "char": "n",
299
+ "description": "The fasta sequence is not editable. Apollo will not load it into the database and instead use the provided indexes to query it. This option assumes the fasta file is bgzip'd with `bgzip` and indexed with `samtools faidx`. Indexes should be named <my.fasta.gz>.gzi and <my.fasta.gz>.fai unless options --fai and --gzi are set",
300
+ "name": "not-editable",
301
+ "allowNo": false,
302
+ "type": "boolean"
303
+ },
304
+ "fai": {
305
+ "description": "Fasta index of the (not-editable) fasta file",
306
+ "name": "fai",
307
+ "hasDynamicHelp": false,
308
+ "multiple": false,
309
+ "type": "option"
310
+ },
311
+ "gzi": {
312
+ "description": "Gzi index of the (not-editable) fasta file",
313
+ "name": "gzi",
314
+ "hasDynamicHelp": false,
315
+ "multiple": false,
316
+ "type": "option"
317
+ },
318
+ "gzip": {
319
+ "char": "z",
320
+ "description": "For local file input: Override autodetection and instruct that input is gzip compressed",
321
+ "exclusive": [
322
+ "decompressed"
323
+ ],
324
+ "name": "gzip",
325
+ "allowNo": false,
326
+ "type": "boolean"
327
+ },
328
+ "decompressed": {
329
+ "char": "d",
330
+ "description": "For local file input: Override autodetection and instruct that input is decompressed",
331
+ "exclusive": [
332
+ "gzip"
333
+ ],
334
+ "name": "decompressed",
335
+ "allowNo": false,
336
+ "type": "boolean"
299
337
  }
300
338
  },
301
339
  "hasDynamicHelp": false,
302
340
  "hiddenAliases": [],
303
- "id": "assembly:add-fasta",
341
+ "id": "assembly:add-from-fasta",
304
342
  "pluginAlias": "@apollo-annotation/cli",
305
343
  "pluginName": "@apollo-annotation/cli",
306
344
  "pluginType": "core",
307
345
  "strict": true,
308
- "enableJsonFlag": false,
346
+ "summary": "Add a new assembly from fasta input",
309
347
  "isESM": true,
310
348
  "relativePath": [
311
349
  "dist",
312
350
  "commands",
313
351
  "assembly",
314
- "add-fasta.js"
352
+ "add-from-fasta.js"
315
353
  ]
316
354
  },
317
- "assembly:add-gff": {
355
+ "assembly:add-from-gff": {
318
356
  "aliases": [],
319
- "args": {},
320
- "description": "The gff file is expected to contain sequences as per gff specifications.\nFeatures are also imported by default.",
357
+ "args": {
358
+ "input-file": {
359
+ "description": "Input gff file",
360
+ "name": "input-file",
361
+ "required": true
362
+ }
363
+ },
364
+ "description": "The gff file is expected to contain sequences as per gff specifications. Features are also imported by default.",
321
365
  "examples": [
322
366
  {
323
367
  "description": "Import sequences and features:",
@@ -325,7 +369,7 @@
325
369
  },
326
370
  {
327
371
  "description": "Import sequences only:",
328
- "command": "<%= config.bin %> <%= command.id %> -i genome.gff -a myAssembly -o"
372
+ "command": "<%= config.bin %> <%= command.id %> genome.gff -a myAssembly -o"
329
373
  }
330
374
  ],
331
375
  "flags": {
@@ -343,15 +387,6 @@
343
387
  "multiple": false,
344
388
  "type": "option"
345
389
  },
346
- "input-file": {
347
- "char": "i",
348
- "description": "Input gff or gtf file",
349
- "name": "input-file",
350
- "required": true,
351
- "hasDynamicHelp": false,
352
- "multiple": false,
353
- "type": "option"
354
- },
355
390
  "assembly": {
356
391
  "char": "a",
357
392
  "description": "Name for this assembly. Use the file name if omitted",
@@ -377,25 +412,24 @@
377
412
  },
378
413
  "hasDynamicHelp": false,
379
414
  "hiddenAliases": [],
380
- "id": "assembly:add-gff",
415
+ "id": "assembly:add-from-gff",
381
416
  "pluginAlias": "@apollo-annotation/cli",
382
417
  "pluginName": "@apollo-annotation/cli",
383
418
  "pluginType": "core",
384
419
  "strict": true,
385
420
  "summary": "Add new assembly from gff or gft file",
386
- "enableJsonFlag": false,
387
421
  "isESM": true,
388
422
  "relativePath": [
389
423
  "dist",
390
424
  "commands",
391
425
  "assembly",
392
- "add-gff.js"
426
+ "add-from-gff.js"
393
427
  ]
394
428
  },
395
429
  "assembly:check": {
396
430
  "aliases": [],
397
431
  "args": {},
398
- "description": "Manage checks, i.e. the rules ensuring features in an assembly are plausible.\nThis command only sets the checks to apply, to retrieve features flagged by\nthese checks use `apollo feature check`.",
432
+ "description": "Manage checks, i.e. the rules ensuring features in an assembly are plausible. This command only sets the checks to apply, to retrieve features flagged by these checks use `apollo feature check`.",
399
433
  "examples": [
400
434
  {
401
435
  "description": "View available check types:",
@@ -657,7 +691,7 @@
657
691
  "change:get": {
658
692
  "aliases": [],
659
693
  "args": {},
660
- "description": "Return the change log in json format. Note that when an assembly is deleted the\nlink between common name and ID is lost (it can still be recovered by inspecting\nthe change log but at present this task is left to the user). In such cases you\nneed to use the assembly ID.",
694
+ "description": "Return the change log in json format. Note that when an assembly is deleted the link between common name and ID is lost (it can still be recovered by inspecting the change log but at present this task is left to the user). In such cases you need to use the assembly ID.",
661
695
  "flags": {
662
696
  "profile": {
663
697
  "description": "Use credentials from this profile",
@@ -699,14 +733,265 @@
699
733
  "get.js"
700
734
  ]
701
735
  },
736
+ "file:delete": {
737
+ "aliases": [],
738
+ "args": {},
739
+ "description": "Deleted files are printed to stdout. See also `apollo file get` to list the files on the server",
740
+ "examples": [
741
+ {
742
+ "description": "Delete file multiple files:",
743
+ "command": "<%= config.bin %> <%= command.id %> -i 123...abc xyz...789"
744
+ }
745
+ ],
746
+ "flags": {
747
+ "profile": {
748
+ "description": "Use credentials from this profile",
749
+ "name": "profile",
750
+ "hasDynamicHelp": false,
751
+ "multiple": false,
752
+ "type": "option"
753
+ },
754
+ "config-file": {
755
+ "description": "Use this config file (mostly for testing)",
756
+ "name": "config-file",
757
+ "hasDynamicHelp": false,
758
+ "multiple": false,
759
+ "type": "option"
760
+ },
761
+ "file-id": {
762
+ "char": "i",
763
+ "description": "IDs of the files to delete",
764
+ "name": "file-id",
765
+ "default": [
766
+ "-"
767
+ ],
768
+ "hasDynamicHelp": false,
769
+ "multiple": true,
770
+ "type": "option"
771
+ }
772
+ },
773
+ "hasDynamicHelp": false,
774
+ "hiddenAliases": [],
775
+ "id": "file:delete",
776
+ "pluginAlias": "@apollo-annotation/cli",
777
+ "pluginName": "@apollo-annotation/cli",
778
+ "pluginType": "core",
779
+ "strict": true,
780
+ "summary": "Delete files from the Apollo server",
781
+ "enableJsonFlag": false,
782
+ "isESM": true,
783
+ "relativePath": [
784
+ "dist",
785
+ "commands",
786
+ "file",
787
+ "delete.js"
788
+ ]
789
+ },
790
+ "file:download": {
791
+ "aliases": [],
792
+ "args": {},
793
+ "description": "See also `apollo file get` to list the files on the server",
794
+ "examples": [
795
+ {
796
+ "description": "Download file with id xyz",
797
+ "command": "<%= config.bin %> <%= command.id %> -i xyz -o genome.fa"
798
+ }
799
+ ],
800
+ "flags": {
801
+ "profile": {
802
+ "description": "Use credentials from this profile",
803
+ "name": "profile",
804
+ "hasDynamicHelp": false,
805
+ "multiple": false,
806
+ "type": "option"
807
+ },
808
+ "config-file": {
809
+ "description": "Use this config file (mostly for testing)",
810
+ "name": "config-file",
811
+ "hasDynamicHelp": false,
812
+ "multiple": false,
813
+ "type": "option"
814
+ },
815
+ "file-id": {
816
+ "char": "i",
817
+ "description": "ID of the file to download",
818
+ "name": "file-id",
819
+ "default": "-",
820
+ "hasDynamicHelp": false,
821
+ "multiple": false,
822
+ "type": "option"
823
+ },
824
+ "output": {
825
+ "char": "o",
826
+ "description": "Write output to this file or \"-\" for stdout. Default to the name of the uploaded file.",
827
+ "name": "output",
828
+ "hasDynamicHelp": false,
829
+ "multiple": false,
830
+ "type": "option"
831
+ }
832
+ },
833
+ "hasDynamicHelp": false,
834
+ "hiddenAliases": [],
835
+ "id": "file:download",
836
+ "pluginAlias": "@apollo-annotation/cli",
837
+ "pluginName": "@apollo-annotation/cli",
838
+ "pluginType": "core",
839
+ "strict": true,
840
+ "summary": "Download a file from the Apollo server",
841
+ "enableJsonFlag": false,
842
+ "isESM": true,
843
+ "relativePath": [
844
+ "dist",
845
+ "commands",
846
+ "file",
847
+ "download.js"
848
+ ]
849
+ },
850
+ "file:get": {
851
+ "aliases": [],
852
+ "args": {},
853
+ "description": "Print to stdout the list of files in json format",
854
+ "examples": [
855
+ {
856
+ "description": "Get files by id:",
857
+ "command": "<%= config.bin %> <%= command.id %> -i xyz abc"
858
+ }
859
+ ],
860
+ "flags": {
861
+ "profile": {
862
+ "description": "Use credentials from this profile",
863
+ "name": "profile",
864
+ "hasDynamicHelp": false,
865
+ "multiple": false,
866
+ "type": "option"
867
+ },
868
+ "config-file": {
869
+ "description": "Use this config file (mostly for testing)",
870
+ "name": "config-file",
871
+ "hasDynamicHelp": false,
872
+ "multiple": false,
873
+ "type": "option"
874
+ },
875
+ "file-id": {
876
+ "char": "i",
877
+ "description": "Get files matching this IDs",
878
+ "name": "file-id",
879
+ "hasDynamicHelp": false,
880
+ "multiple": true,
881
+ "type": "option"
882
+ }
883
+ },
884
+ "hasDynamicHelp": false,
885
+ "hiddenAliases": [],
886
+ "id": "file:get",
887
+ "pluginAlias": "@apollo-annotation/cli",
888
+ "pluginName": "@apollo-annotation/cli",
889
+ "pluginType": "core",
890
+ "strict": true,
891
+ "summary": "Get list of files uploaded to the Apollo server",
892
+ "enableJsonFlag": false,
893
+ "isESM": true,
894
+ "relativePath": [
895
+ "dist",
896
+ "commands",
897
+ "file",
898
+ "get.js"
899
+ ]
900
+ },
901
+ "file:upload": {
902
+ "aliases": [],
903
+ "args": {},
904
+ "description": "This command only uploads a file and returns the corresponding file id.\n To add an assembly based on this file or to upload & add an assembly in a single pass see `apollo assembly add-from-fasta` and `add-from-gff`",
905
+ "examples": [
906
+ {
907
+ "description": "Upload local file, type auto-detected:",
908
+ "command": "<%= config.bin %> <%= command.id %> -i genome.fa > file.json"
909
+ }
910
+ ],
911
+ "flags": {
912
+ "profile": {
913
+ "description": "Use credentials from this profile",
914
+ "name": "profile",
915
+ "hasDynamicHelp": false,
916
+ "multiple": false,
917
+ "type": "option"
918
+ },
919
+ "config-file": {
920
+ "description": "Use this config file (mostly for testing)",
921
+ "name": "config-file",
922
+ "hasDynamicHelp": false,
923
+ "multiple": false,
924
+ "type": "option"
925
+ },
926
+ "input-file": {
927
+ "char": "i",
928
+ "description": "Local file to upload",
929
+ "name": "input-file",
930
+ "required": true,
931
+ "hasDynamicHelp": false,
932
+ "multiple": false,
933
+ "type": "option"
934
+ },
935
+ "type": {
936
+ "char": "t",
937
+ "description": "Set file type or autodetected it if not set.\n NB: There is no check for whether the file complies to this type",
938
+ "name": "type",
939
+ "hasDynamicHelp": false,
940
+ "multiple": false,
941
+ "options": [
942
+ "text/x-fasta",
943
+ "text/x-gff3",
944
+ "application/x-bgzip-fasta",
945
+ "text/x-fai",
946
+ "application/x-gzi"
947
+ ],
948
+ "type": "option"
949
+ },
950
+ "gzip": {
951
+ "char": "z",
952
+ "description": "Override autodetection and instruct that input is gzip compressed",
953
+ "exclusive": [
954
+ "decompressed"
955
+ ],
956
+ "name": "gzip",
957
+ "allowNo": false,
958
+ "type": "boolean"
959
+ },
960
+ "decompressed": {
961
+ "char": "d",
962
+ "description": "Override autodetection and instruct that input is decompressed",
963
+ "exclusive": [
964
+ "gzip"
965
+ ],
966
+ "name": "decompressed",
967
+ "allowNo": false,
968
+ "type": "boolean"
969
+ }
970
+ },
971
+ "hasDynamicHelp": false,
972
+ "hiddenAliases": [],
973
+ "id": "file:upload",
974
+ "pluginAlias": "@apollo-annotation/cli",
975
+ "pluginName": "@apollo-annotation/cli",
976
+ "pluginType": "core",
977
+ "strict": true,
978
+ "summary": "Upload a local file to the Apollo server",
979
+ "isESM": true,
980
+ "relativePath": [
981
+ "dist",
982
+ "commands",
983
+ "file",
984
+ "upload.js"
985
+ ]
986
+ },
702
987
  "feature:add-child": {
703
988
  "aliases": [],
704
989
  "args": {},
705
- "description": "See the other commands under `apollo feature` to retrive the parent ID of\ninterest and to populate the child feature with attributes.",
990
+ "description": "See the other commands under `apollo feature` to retrive the parent ID of interest and to populate the child feature with attributes.",
706
991
  "examples": [
707
992
  {
708
993
  "description": "Add an exon at genomic coordinates 10..20 to this feature ID:",
709
- "command": "<%= config.bin %> <%= command.id %> -i 6605826fbd0eee691f83e73f -t exon -s 10 -e 20"
994
+ "command": "<%= config.bin %> <%= command.id %> -i 660...73f -t exon -s 10 -e 20"
710
995
  }
711
996
  ],
712
997
  "flags": {
@@ -781,7 +1066,7 @@
781
1066
  "feature:check": {
782
1067
  "aliases": [],
783
1068
  "args": {},
784
- "description": "Use this command to view which features fail checks along with the reason for\nfailing. Use `apollo assembly check` for managing which checks should be applied\nto an assembly",
1069
+ "description": "Use this command to view which features fail checks along with the reason for failing.Use `apollo assembly check` for managing which checks should be applied to an assembly",
785
1070
  "examples": [
786
1071
  {
787
1072
  "description": "Get all check results in the database:",
@@ -844,7 +1129,7 @@
844
1129
  "feature:copy": {
845
1130
  "aliases": [],
846
1131
  "args": {},
847
- "description": "The feature may be copied to the same or to a different assembly. he destination\nreference sequence may be selected by name only if unique in the database or by\nname and assembly or by identifier.",
1132
+ "description": "The feature may be copied to the same or to a different assembly. The destination reference sequence may be selected by name only if unique in the database or by name and assembly or by identifier.",
848
1133
  "examples": [
849
1134
  {
850
1135
  "description": "Copy this feature ID to chr1:100 in assembly hg38:",
@@ -923,7 +1208,7 @@
923
1208
  "feature:delete": {
924
1209
  "aliases": [],
925
1210
  "args": {},
926
- "description": "Note that deleting a child feature after deleting its parent will result in an\nerror unless you set -f/--force.",
1211
+ "description": "Note that deleting a child feature after deleting its parent will result in an error unless you set -f/--force.",
927
1212
  "flags": {
928
1213
  "profile": {
929
1214
  "description": "Use credentials from this profile",
@@ -985,7 +1270,7 @@
985
1270
  "feature:edit-attribute": {
986
1271
  "aliases": [],
987
1272
  "args": {},
988
- "description": "Be aware that there is no checking whether attributes names and values are\nvalid. For example, you can create non-unique ID attributes or you can set gene\nontology terms to non-existing terms",
1273
+ "description": "Be aware that there is no checking whether attributes names and values are valid. For example, you can create non-unique ID attributes or you can set gene ontology terms to non-existing terms",
989
1274
  "examples": [
990
1275
  {
991
1276
  "description": "Add attribute \"domains\" with a list of values:",
@@ -1069,7 +1354,7 @@
1069
1354
  "feature:edit-coords": {
1070
1355
  "aliases": [],
1071
1356
  "args": {},
1072
- "description": "If editing a child feature that new coordinates must be within the parent's\ncoordinates. To get the identifier of the feature to edit consider using `apollo\nfeature get` or `apollo feature search`",
1357
+ "description": "If editing a child feature that new coordinates must be within the parent's coordinates.To get the identifier of the feature to edit consider using `apollo feature get` or `apollo feature search`",
1073
1358
  "examples": [
1074
1359
  {
1075
1360
  "description": "Edit start and end:",
@@ -1141,7 +1426,7 @@
1141
1426
  "feature:edit-type": {
1142
1427
  "aliases": [],
1143
1428
  "args": {},
1144
- "description": "Feature type is column 3 in gff format. It must be a valid sequence ontology\nterm although but the valifdity of the new term is not checked.",
1429
+ "description": "Feature type is column 3 in gff format.It must be a valid sequence ontology term although but the valifdity of the new term is not checked.",
1145
1430
  "flags": {
1146
1431
  "profile": {
1147
1432
  "description": "Use credentials from this profile",
@@ -1195,7 +1480,7 @@
1195
1480
  "feature:edit": {
1196
1481
  "aliases": [],
1197
1482
  "args": {},
1198
- "description": "Edit a feature by submitting a json input with all the required attributes for\nApollo to process it. This is a very low level command which most users probably\ndo not need.\n\n Input may be a json string or a json file and it may be an array of changes.\nThis is an example input for editing feature type:\n\n {\n \"typeName\": \"TypeChange\",\n \"changedIds\": [\n \"6613f7d22c957525d631b1cc\"\n ],\n \"assembly\": \"6613f7d1360321540a11e5ed\",\n \"featureId\": \"6613f7d22c957525d631b1cc\",\n \"oldType\": \"BAC\",\n \"newType\": \"G_quartet\"\n }",
1483
+ "description": "Edit a feature by submitting a json input with all the required attributes for Apollo to process it. This is a very low level command which most users probably do not need.\n\n 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 feature type:\n\n {\n \"typeName\": \"TypeChange\",\n \"changedIds\": [\n \"6613f7d22c957525d631b1cc\"\n ],\n \"assembly\": \"6613f7d1360321540a11e5ed\",\n \"featureId\": \"6613f7d22c957525d631b1cc\",\n \"oldType\": \"BAC\",\n \"newType\": \"G_quartet\"\n }",
1199
1484
  "examples": [
1200
1485
  {
1201
1486
  "description": "Editing by passing a json to stdin:",
@@ -1247,7 +1532,7 @@
1247
1532
  "feature:get-id": {
1248
1533
  "aliases": [],
1249
1534
  "args": {},
1250
- "description": "Invalid identifiers or identifiers not found in the database will be silently\nignored",
1535
+ "description": "Invalid identifiers or identifiers not found in the database will be silently ignored",
1251
1536
  "examples": [
1252
1537
  {
1253
1538
  "description": "Get features for these identifiers:",
@@ -1271,7 +1556,7 @@
1271
1556
  },
1272
1557
  "feature-id": {
1273
1558
  "char": "i",
1274
- "description": "Retrieves feature with these IDs. Use\n\"-\" to read IDs from stdin (one per\nline)",
1559
+ "description": "Retrieves feature with these IDs. Use \"-\" to read IDs from stdin (one per line)",
1275
1560
  "name": "feature-id",
1276
1561
  "default": [
1277
1562
  "-"
@@ -1308,7 +1593,7 @@
1308
1593
  "command": "<%= config.bin %> <%= command.id %> -a myAssembly"
1309
1594
  },
1310
1595
  {
1311
- "description": "Get features intersecting chr1:1..1000. You can omit the assembly name if there\nare no other reference sequences named chr1:",
1596
+ "description": "Get features intersecting chr1:1..1000. You can omit the assembly name if there are no other reference sequences named chr1:",
1312
1597
  "command": "<%= config.bin %> <%= command.id %> -a myAssembly -r chr1 -s 1 -e 1000"
1313
1598
  }
1314
1599
  ],
@@ -1404,7 +1689,7 @@
1404
1689
  },
1405
1690
  "input-file": {
1406
1691
  "char": "i",
1407
- "description": "Input gff or gtf file",
1692
+ "description": "Input gff file",
1408
1693
  "name": "input-file",
1409
1694
  "required": true,
1410
1695
  "hasDynamicHelp": false,
@@ -1436,7 +1721,6 @@
1436
1721
  "pluginType": "core",
1437
1722
  "strict": true,
1438
1723
  "summary": "Import features from local gff file",
1439
- "enableJsonFlag": false,
1440
1724
  "isESM": true,
1441
1725
  "relativePath": [
1442
1726
  "dist",
@@ -1448,7 +1732,7 @@
1448
1732
  "feature:search": {
1449
1733
  "aliases": [],
1450
1734
  "args": {},
1451
- "description": "Return features matching a query string. This command searches only in:\n\n - Attribute *values* (not attribute names)\n - Source field (which in fact is stored as an attribute)\n - Feature type\n\n The search mode is:\n\n - Case insensitive\n - Match only full words, but not necessarily the full value\n - Common words are ignored. E.g. \"the\", \"with\"\n\n For example, given this feature:\n\n chr1 example SNP 10 30 0.987 . . \"someKey=Fingerprint BAC with reads\"\n\n Queries \"bac\" or \"mRNA\" return the feature. Instead these queries will NOT\nmatch:\n\n - \"someKey\"\n - \"with\"\n - \"Finger\"\n - \"chr1\"\n - \"0.987\"",
1735
+ "description": "Return features matching a query string. This command searches only in:\n\n - Attribute *values* (not attribute names)\n - Source field (which in fact is stored as an attribute)\n - Feature type\n\n The search mode is:\n\n - Case insensitive\n - Match only full words, but not necessarily the full value\n - Common words are ignored. E.g. \"the\", \"with\"\n\n For example, given this feature:\n\n chr1 example SNP 10 30 0.987 . . \"someKey=Fingerprint BAC with reads\"\n\n Queries \"bac\" or \"mRNA\" return the feature. Instead these queries will NOT match:\n\n - \"someKey\"\n - \"with\"\n - \"Finger\"\n - \"chr1\"\n - \"0.987\"",
1452
1736
  "examples": [
1453
1737
  {
1454
1738
  "description": "Search \"bac\" in these assemblies:",
@@ -1481,7 +1765,7 @@
1481
1765
  },
1482
1766
  "assembly": {
1483
1767
  "char": "a",
1484
- "description": "Assembly names or IDs to search; use \"-\" to read it from stdin. If omitted\nsearch all assemblies",
1768
+ "description": "Assembly names or IDs to search; use \"-\" to read it from stdin. If omitted search all assemblies",
1485
1769
  "name": "assembly",
1486
1770
  "hasDynamicHelp": false,
1487
1771
  "multiple": true,
@@ -1505,10 +1789,163 @@
1505
1789
  "search.js"
1506
1790
  ]
1507
1791
  },
1792
+ "jbrowse:get-config": {
1793
+ "aliases": [],
1794
+ "args": {},
1795
+ "description": "Print to stdout the JBrowse configuration from Apollo in JSON format",
1796
+ "examples": [
1797
+ {
1798
+ "description": "Get JBrowse configuration:",
1799
+ "command": "<%= config.bin %> <%= command.id %> > config.json"
1800
+ }
1801
+ ],
1802
+ "flags": {
1803
+ "profile": {
1804
+ "description": "Use credentials from this profile",
1805
+ "name": "profile",
1806
+ "hasDynamicHelp": false,
1807
+ "multiple": false,
1808
+ "type": "option"
1809
+ },
1810
+ "config-file": {
1811
+ "description": "Use this config file (mostly for testing)",
1812
+ "name": "config-file",
1813
+ "hasDynamicHelp": false,
1814
+ "multiple": false,
1815
+ "type": "option"
1816
+ }
1817
+ },
1818
+ "hasDynamicHelp": false,
1819
+ "hiddenAliases": [],
1820
+ "id": "jbrowse:get-config",
1821
+ "pluginAlias": "@apollo-annotation/cli",
1822
+ "pluginName": "@apollo-annotation/cli",
1823
+ "pluginType": "core",
1824
+ "strict": true,
1825
+ "summary": "Get JBrowse configuration from Apollo",
1826
+ "enableJsonFlag": false,
1827
+ "isESM": true,
1828
+ "relativePath": [
1829
+ "dist",
1830
+ "commands",
1831
+ "jbrowse",
1832
+ "get-config.js"
1833
+ ]
1834
+ },
1835
+ "jbrowse:set-config": {
1836
+ "aliases": [],
1837
+ "args": {
1838
+ "inputFile": {
1839
+ "description": "JBrowse configuration file",
1840
+ "name": "inputFile",
1841
+ "required": true
1842
+ }
1843
+ },
1844
+ "description": "Set JBrowse configuration in Apollo collaboration server",
1845
+ "examples": [
1846
+ {
1847
+ "description": "Add JBrowse configuration:",
1848
+ "command": "<%= config.bin %> <%= command.id %> config.json"
1849
+ }
1850
+ ],
1851
+ "flags": {
1852
+ "profile": {
1853
+ "description": "Use credentials from this profile",
1854
+ "name": "profile",
1855
+ "hasDynamicHelp": false,
1856
+ "multiple": false,
1857
+ "type": "option"
1858
+ },
1859
+ "config-file": {
1860
+ "description": "Use this config file (mostly for testing)",
1861
+ "name": "config-file",
1862
+ "hasDynamicHelp": false,
1863
+ "multiple": false,
1864
+ "type": "option"
1865
+ }
1866
+ },
1867
+ "hasDynamicHelp": false,
1868
+ "hiddenAliases": [],
1869
+ "id": "jbrowse:set-config",
1870
+ "pluginAlias": "@apollo-annotation/cli",
1871
+ "pluginName": "@apollo-annotation/cli",
1872
+ "pluginType": "core",
1873
+ "strict": true,
1874
+ "summary": "Set JBrowse configuration",
1875
+ "enableJsonFlag": false,
1876
+ "isESM": true,
1877
+ "relativePath": [
1878
+ "dist",
1879
+ "commands",
1880
+ "jbrowse",
1881
+ "set-config.js"
1882
+ ]
1883
+ },
1884
+ "refseq:add-alias": {
1885
+ "aliases": [],
1886
+ "args": {},
1887
+ "description": "Reference name aliasing is a process to make chromosomes that are named slightly differently but which refer to the same thing render properly. This command reads a file with reference name aliases and adds them to the database.",
1888
+ "examples": [
1889
+ {
1890
+ "description": "Add reference name aliases:",
1891
+ "command": "<%= config.bin %> <%= command.id %> -i alias.txt -a myAssembly"
1892
+ }
1893
+ ],
1894
+ "flags": {
1895
+ "profile": {
1896
+ "description": "Use credentials from this profile",
1897
+ "name": "profile",
1898
+ "hasDynamicHelp": false,
1899
+ "multiple": false,
1900
+ "type": "option"
1901
+ },
1902
+ "config-file": {
1903
+ "description": "Use this config file (mostly for testing)",
1904
+ "name": "config-file",
1905
+ "hasDynamicHelp": false,
1906
+ "multiple": false,
1907
+ "type": "option"
1908
+ },
1909
+ "input-file": {
1910
+ "char": "i",
1911
+ "description": "Input refname alias file",
1912
+ "name": "input-file",
1913
+ "required": true,
1914
+ "hasDynamicHelp": false,
1915
+ "multiple": false,
1916
+ "type": "option"
1917
+ },
1918
+ "assembly": {
1919
+ "char": "a",
1920
+ "description": "Name for this assembly.",
1921
+ "name": "assembly",
1922
+ "required": true,
1923
+ "hasDynamicHelp": false,
1924
+ "multiple": false,
1925
+ "type": "option"
1926
+ }
1927
+ },
1928
+ "hasDynamicHelp": false,
1929
+ "hiddenAliases": [],
1930
+ "id": "refseq:add-alias",
1931
+ "pluginAlias": "@apollo-annotation/cli",
1932
+ "pluginName": "@apollo-annotation/cli",
1933
+ "pluginType": "core",
1934
+ "strict": true,
1935
+ "summary": "Add reference name aliases from a file",
1936
+ "enableJsonFlag": false,
1937
+ "isESM": true,
1938
+ "relativePath": [
1939
+ "dist",
1940
+ "commands",
1941
+ "refseq",
1942
+ "add-alias.js"
1943
+ ]
1944
+ },
1508
1945
  "refseq:get": {
1509
1946
  "aliases": [],
1510
1947
  "args": {},
1511
- "description": "Output the reference sequences in one or more assemblies in json format. This\ncommand returns the sequence characteristics (e.g., name, ID, etc), not the DNA\nsequences. Use `assembly sequence` for that.",
1948
+ "description": "Output the reference sequences in one or more assemblies in json format. This command returns the sequence characteristics (e.g., name, ID, etc), not the DNA sequences. Use `assembly sequence` for that.",
1512
1949
  "examples": [
1513
1950
  {
1514
1951
  "description": "All sequences in the database:",
@@ -1628,5 +2065,5 @@
1628
2065
  ]
1629
2066
  }
1630
2067
  },
1631
- "version": "0.1.18"
2068
+ "version": "0.1.20"
1632
2069
  }