Command model
EHItk commands have the form:
ehitk [global options] <resource> <action> [action options]
Resources
specimensHost and specimen metadata. This resource supports
fields,query,values, andstats.hologenomesShotgun sequencing datasets linked to specimens. This resource supports
fields,query,values,stats, andfetch.magsMetagenome-assembled genomes linked to parent hologenomes and host specimens. This resource supports
fields,query,values,stats, andfetch.databaseShow the SQLite catalog currently used by EHItk: whether it is the bundled catalog or an alternate catalog passed with
--db, its path, size, SHA256 checksum, and itsdata_version/schema_version(unknownfor older catalogs built before this metadata existed).
Actions
fieldsLists the field names accepted by
values --field, including aliases and the canonical field each alias resolves to.queryPrints matching records as a rich table by default, or emits CSV/TSV to standard output or
--output-file.valuesCounts distinct values for one field after applying the same filters used by
query.statsPrints a compact summary of a filtered subset.
fetchDownloads files for matching hologenomes or MAGs, or writes a batch shell script with
curlcommands.
Global options
--versionShow the installed EHItk version and exit.
--db PATHUse an alternate SQLite catalog instead of the bundled database.
Help
All command levels include help text:
ehitk --help
ehitk specimens --help
ehitk hologenomes --help
ehitk mags --help
ehitk mags query --help