Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Developer Documentation

This documentation should serve as a technical basis for new & experienced user of this tool.

Work on documentation locally

mdbook serve docs

Generate the CLI reference documentation

To generate the reference documentation directly from the code use this command:

python ./docs/tool/generate_md_doc.py dumps --baseModule=nixos_compose.cli --baseCommand=nxc --docsPath=./docs/src/references/commands

References

Diátaxis