Skip to content
chromosomix

Installing the command line

The chromosomix command runs the tasks of the Analysis panel from a shell, with the same parameters and results. It needs Node.js 22.12 or later:

Terminal window
node --version
Terminal window
npm install -g chromosomix

Check that it answers by listing its tasks:

Terminal window
chromosomix tasks

A pipeline or a methods section should name the release it used:

Terminal window
npm install -g chromosomix@<version>

Or run a release with npx, without installing anything:

Terminal window
npx chromosomix@<version> insulation sample.cool --window 10 --out results/

Releases are listed on GitHub and npm.

Terminal window
chromosomix --version

It prints four lines, and runs nothing else:

chromosomix <version> (<commit>)
node <version> on <platform>-<arch>
h5wasm <version>
@gmod/bbi <version>

The last two are the libraries that read every map and track, which npm settles at install time: two installs of one release can differ, so keep all four lines in a pipeline’s record. Every table the command writes opens with the release, as # chromosomix <version> cli.

To run a change that is not released yet:

Terminal window
git clone https://github.com/js2264/chromosomix
cd chromosomix
npm install
npm run build:cli && npm link

npm link puts this build on your PATH as chromosomix.

Next: Running a task, then In a pipeline.

Documentation of chromosomix v0.20.0 · built from 40ec1ec · source