Man pages for orderly
Lightweight Reproducible Reporting

orderly_artefactDeclare orderly artefacts
orderly_cleanupClean up source directory
orderly_compare_packetsCompare the metadata and contents of two packets.
orderly_comparison_explainPrint the details of a packet comparison.
orderly_configRead configuration
orderly_config_setSet configuration options
orderly_copy_filesCopy files from a packet
orderly_dependencyDeclare a dependency
orderly-deprecatedDeprecated functions in orderly. These functions still work...
orderly_descriptionDescribe the current packet
orderly_exampleCopy a simple orderly example
orderly_example_showShow an example file
orderly_gitignore_updateUpdate a gitignore file
orderly_hashCompute a hash
orderly_initInitialise an orderly repository
orderly_interactive_set_search_optionsSet search options for interactive use
orderly_list_srcList source reports
orderly_location_addAdd a new location
orderly_location_fetch_metadataFetch metadata from a location
orderly_location_listList known pack locations
orderly_location_pullPull one or more packets from a location
orderly_location_pushPush tree to location
orderly_location_removeRemove a location
orderly_location_renameRename a location
orderly_metadataRead outpack metadata
orderly_metadata_extractExtract metadata from orderly packets
orderly_metadata_readRead outpack metadata json file
orderly_migrate_sourceMigrate orderly source code
orderly_newCreate a new report
orderly_parametersDeclare orderly parameters
orderly_parse_fileParse the orderly entrypoint script
orderly_plugin_add_metadataAdd metadata from plugin
orderly_plugin_contextFetch plugin context
orderly_plugin_registerRegister an orderly plugin
orderly_prune_orphansPrune orphan packet metadata
orderly_queryConstruct outpack query
orderly_query_explainExplain a query
orderly_resourceDeclare orderly resources
orderly_runRun a report
orderly_run_infoInformation about currently running report
orderly_searchQuery orderly's database
orderly_search_optionsPacket search options
orderly_shared_resourceCopy shared resources into a packet directory
orderly_strict_modeEnable orderly strict mode
orderly_validate_archiveValidate unpacked packets.
orderly documentation built on Jan. 24, 2026, 1:07 a.m.