Skip to content

Commit 80b2004

Browse files
docs: regenerate cli reference
1 parent 7298c7b commit 80b2004

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

docs/user/nextclade-cli/reference.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ If you have Nextclade CLI installed, you can type `nextclade --help` to read the
1616
* [`nextclade dataset get`](#nextclade-dataset-get)
1717
* [`nextclade sort`](#nextclade-sort)
1818
* [`nextclade read-annotation`](#nextclade-read-annotation)
19+
* [`nextclade schema`](#nextclade-schema)
20+
* [`nextclade schema write`](#nextclade-schema-write)
1921
* [`nextclade help-markdown`](#nextclade-help-markdown)
2022

2123
## `nextclade`
@@ -41,6 +43,7 @@ For short help type: `nextclade -h`, for extended help type: `nextclade --help`.
4143
* `dataset` — List and download available Nextclade datasets (pathogens)
4244
* `sort` — Sort sequences according to the inferred Nextclade dataset (pathogen)
4345
* `read-annotation` — Read genome annotation and present it in Nextclade's internal formats. This is mostly only useful for Nextclade maintainers and the most curious users. Note that these internal formats have no stability guarantees and can be changed at any time without notice
46+
* `schema` — Write JSON schema definitions for Nextclade file formats
4447
* `help-markdown` — Print command-line reference documentation in Markdown format
4548

4649
###### **Options:**
@@ -651,6 +654,68 @@ For short help type: `nextclade -h`, for extended help type: `nextclade --help`.
651654

652655

653656

657+
## `nextclade schema`
658+
659+
Write JSON schema definitions for Nextclade file formats
660+
661+
See: https://json-schema.org
662+
663+
**Usage:** `nextclade schema <COMMAND>`
664+
665+
###### **Subcommands:**
666+
667+
* `write` — Write JSON schema definitions for Nextclade formats
668+
669+
670+
671+
## `nextclade schema write`
672+
673+
Write JSON schema definitions for Nextclade formats
674+
675+
See: https://json-schema.org
676+
677+
**Usage:** `nextclade schema write [OPTIONS]`
678+
679+
###### **Options:**
680+
681+
* `-o`, `--output <OUTPUT>` — Write JSON schema definitions to this file (--for=<format>) or directory (--for=all).
682+
683+
Can produce schema file in JSON or YAML format, depending on the file extension provided. Use "-" to write the data in JSON format to standard output.
684+
685+
Use --as=json or --as=yaml to force a particular output schema format.
686+
* `-f`, `--for <FOR_FORMAT>` — Write JSON schema definitions for this file format
687+
688+
Use 'all' to output schemas for all formats to a given directory
689+
690+
Default value: `all`
691+
692+
Possible values:
693+
- `all`:
694+
All formats
695+
- `input-pathogen-json`:
696+
"Input pathogen JSON" format (`nextclade run --input-pathogen-json`)
697+
- `output-json`:
698+
"Nextclade output JSON" format (`nextclade run --output-json`)
699+
- `output-ndjson`:
700+
A single entry in "Nextclade output NDJSON" format (`nextclade run --output-ndjson`). Same format as for the entries in "Nextclade output JSON" `.results` array
701+
- `output-dataset-list-json`:
702+
A list of datasets produced with `nextclade dataset list --json`
703+
- `internal-index-json`:
704+
Index JSON format. This format is used to store a list of known datasets and their properties. This is how Nextclade knows which datasets are available for a given pathogen (e.g. to display them in the web UI or with `nextclade dataset list` command). This is an internal format, not meant to be used directly. Hosted at: http://data.clades.nextstrain.org/v3/index.json Produced at: https://github.com/nextstrain/nextclade_data
705+
- `internal-minimizer-index-json`:
706+
Minimizer index JSON format. This format is used to store minimizer data which is used for dataset detection from sequences (dataset suggestions in Nextclade Web and `nextclade sort` command). This is an internal format, not meant to be used directly. Hosted at: http://data.clades.nextstrain.org/v3/minimizer_index.json Produced at: https://github.com/nextstrain/nextclade_data
707+
708+
* `-a`, `--as <AS_FORMAT>` — Force output format of the produced schema file(s)
709+
710+
With the default value 'auto', the format will be deduced based on output file extension
711+
712+
Default value: `auto`
713+
714+
Possible values: `auto`, `json`, `yaml`
715+
716+
717+
718+
654719
## `nextclade help-markdown`
655720

656721
Print command-line reference documentation in Markdown format

0 commit comments

Comments
 (0)