Skip to main content

mr CLI reference

CommandShort
mr adminServer administration commandsDetails
mr admin settingsView and manage runtime configuration overridesDetails
mr admin settings getShow a single runtime setting by keyDetails
mr admin settings listList all runtime settingsDetails
mr admin settings resetRemove a runtime override and revert to boot defaultDetails
mr admin settings setOverride a runtime settingDetails
mr admin statsShow server and data statisticsDetails
mr categoriesList group categoriesDetails
mr categories listList categoriesDetails
mr categories timelineDisplay a timeline of category activityDetails
mr categoryGet, create, edit, or delete a group categoryDetails
mr category createCreate a new categoryDetails
mr category deleteDelete a category by IDDetails
mr category edit-descriptionEdit a category's descriptionDetails
mr category edit-nameEdit a category's nameDetails
mr category getGet a category by IDDetails
mr docsIntrospect and validate the mr CLI's own documentationDetails
mr docs check-examplesRun # mr-doctest: example blocks against a live serverDetails
mr docs dumpEmit the mr command tree as JSON or MarkdownDetails
mr docs lintValidate every command's help against the templateDetails
mr groupGet, create, edit, delete, or clone a groupDetails
mr group childrenList child groups (tree children) of a groupDetails
mr group cloneClone a groupDetails
mr group createCreate a new groupDetails
mr group deleteDelete a group by IDDetails
mr group edit-descriptionEdit a group's descriptionDetails
mr group edit-metaEdit a single metadata field by JSON pathDetails
mr group edit-nameEdit a group's nameDetails
mr group exportExport one or more groups to a tar archiveDetails
mr group getGet a group by IDDetails
mr group importImport a group export tar into this instanceDetails
mr group parentsList parent groups of a groupDetails
mr groupsList, merge, or bulk-edit groupsDetails
mr groups add-metaAdd metadata to multiple groupsDetails
mr groups add-tagsAdd tags to multiple groupsDetails
mr groups deleteDelete multiple groupsDetails
mr groups listList groupsDetails
mr groups mergeMerge groups into a winnerDetails
mr groups meta-keysList all unique metadata keys used across groupsDetails
mr groups remove-tagsRemove tags from multiple groupsDetails
mr groups timelineDisplay a timeline of group activityDetails
mr jobSubmit, cancel, pause, or retry a download jobDetails
mr job cancelCancel a jobDetails
mr job pausePause a jobDetails
mr job resumeResume a jobDetails
mr job retryRetry a failed jobDetails
mr job submitSubmit URLs for downloadDetails
mr jobsView the download job queueDetails
mr jobs listList the download queueDetails
mr logView a log entry or entity historyDetails
mr log entityGet log entries for a specific entityDetails
mr log getGet a log entry by IDDetails
mr logsList and filter audit log entriesDetails
mr logs listList log entriesDetails
mr mrqlExecute and manage MRQL queriesDetails
mr mrql deleteDelete a saved MRQL query by IDDetails
mr mrql listList saved MRQL queriesDetails
mr mrql runRun a saved MRQL query by name or IDDetails
mr mrql saveSave a MRQL queryDetails
mr noteGet, create, edit, delete, or share a noteDetails
mr note createCreate a new noteDetails
mr note deleteDelete a note by IDDetails
mr note edit-descriptionEdit a note's descriptionDetails
mr note edit-metaEdit a single metadata field by JSON pathDetails
mr note edit-nameEdit a note's nameDetails
mr note getGet a note by IDDetails
mr note shareGenerate a share token for a noteDetails
mr note unshareRemove the share token from a noteDetails
mr note-blockGet, create, update, or delete a note blockDetails
mr note-block createCreate a new note blockDetails
mr note-block deleteDelete a note block by IDDetails
mr note-block getGet a note block by IDDetails
mr note-block typesShow available block types (text, table, calendar, etc.)Details
mr note-block updateUpdate a note block's contentDetails
mr note-block update-stateUpdate a note block's stateDetails
mr note-blocksList, reorder, or rebalance note blocksDetails
mr note-blocks listList note blocks for a noteDetails
mr note-blocks rebalanceRebalance note block positionsDetails
mr note-blocks reorderReorder note blocksDetails
mr note-typeGet, create, edit, or delete a note typeDetails
mr note-type createCreate a new note typeDetails
mr note-type deleteDelete a note type by IDDetails
mr note-type editEdit a note typeDetails
mr note-type edit-descriptionEdit a note type's descriptionDetails
mr note-type edit-nameEdit a note type's nameDetails
mr note-type getGet a note type by IDDetails
mr note-typesList note typesDetails
mr note-types listList note typesDetails
mr notesList notes and bulk tag/group/meta operationsDetails
mr notes add-groupsAdd groups to multiple notesDetails
mr notes add-metaAdd metadata to multiple notesDetails
mr notes add-tagsAdd tags to multiple notesDetails
mr notes deleteDelete multiple notesDetails
mr notes listList notesDetails
mr notes meta-keysList all unique metadata keys used across notesDetails
mr notes remove-tagsRemove tags from multiple notesDetails
mr notes timelineDisplay a timeline of note activityDetails
mr pluginEnable, disable, or configure a pluginDetails
mr plugin disableDisable a pluginDetails
mr plugin enableEnable a pluginDetails
mr plugin purge-dataPurge all data for a pluginDetails
mr plugin settingsUpdate plugin settings (pass JSON via --data)Details
mr pluginsList installed pluginsDetails
mr plugins listList plugins and management infoDetails
mr queriesList saved queriesDetails
mr queries listList queriesDetails
mr queries timelineDisplay a timeline of query activityDetails
mr queryGet, create, run, or delete a saved queryDetails
mr query createCreate a new queryDetails
mr query deleteDelete a query by IDDetails
mr query edit-descriptionEdit a query's descriptionDetails
mr query edit-nameEdit a query's nameDetails
mr query getGet a query by IDDetails
mr query runRun a query by IDDetails
mr query run-by-nameRun a query by nameDetails
mr query schemaShow database table and column names for query buildingDetails
mr relationCreate, edit, or delete a group relationDetails
mr relation createCreate a new group relationDetails
mr relation deleteDelete a relation by IDDetails
mr relation edit-descriptionEdit a relation's descriptionDetails
mr relation edit-nameEdit a relation's nameDetails
mr relation-typeCreate, edit, or delete a relation typeDetails
mr relation-type createCreate a new relation typeDetails
mr relation-type deleteDelete a relation type by IDDetails
mr relation-type editEdit a relation typeDetails
mr relation-type edit-descriptionEdit a relation type's descriptionDetails
mr relation-type edit-nameEdit a relation type's nameDetails
mr relation-typesList relation typesDetails
mr relation-types listList relation typesDetails
mr resourceUpload, download, edit, or version a resourceDetails
mr resource deleteDelete a resource by IDDetails
mr resource downloadDownload a resource fileDetails
mr resource editEdit a resourceDetails
mr resource edit-descriptionEdit a resource's descriptionDetails
mr resource edit-metaEdit a single metadata field by JSON pathDetails
mr resource edit-nameEdit a resource's nameDetails
mr resource from-localCreate a resource from a local server pathDetails
mr resource from-urlCreate a resource from a remote URLDetails
mr resource getGet a resource by IDDetails
mr resource previewDownload a scaled thumbnail of a resourceDetails
mr resource recalculate-dimensionsRecalculate resource dimensionsDetails
mr resource rotateRotate a resource imageDetails
mr resource uploadUpload a file as a new resourceDetails
mr resource versionGet a specific version by IDDetails
mr resource version-deleteDelete a specific versionDetails
mr resource version-downloadDownload a specific version fileDetails
mr resource version-restoreRestore a resource to a previous versionDetails
mr resource version-uploadUpload a new version of a resourceDetails
mr resource versionsList versions of a resourceDetails
mr resource versions-cleanupClean up old versions of a resourceDetails
mr resource versions-compareCompare two versions of a resourceDetails
mr resource-categoriesList resource categoriesDetails
mr resource-categories listList resource categoriesDetails
mr resource-categoryGet, create, edit, or delete a resource categoryDetails
mr resource-category createCreate a new resource categoryDetails
mr resource-category deleteDelete a resource category by IDDetails
mr resource-category edit-descriptionEdit a resource category's descriptionDetails
mr resource-category edit-nameEdit a resource category's nameDetails
mr resource-category getGet a resource category by IDDetails
mr resourcesList, merge, or bulk-edit resourcesDetails
mr resources add-groupsAdd groups to multiple resourcesDetails
mr resources add-metaAdd metadata to multiple resourcesDetails
mr resources add-tagsAdd tags to multiple resourcesDetails
mr resources deleteDelete multiple resourcesDetails
mr resources listList resourcesDetails
mr resources mergeMerge resources into a winnerDetails
mr resources meta-keysList all unique metadata keys used across resourcesDetails
mr resources remove-tagsRemove tags from multiple resourcesDetails
mr resources replace-tagsReplace tags on multiple resourcesDetails
mr resources set-dimensionsSet dimensions on multiple resourcesDetails
mr resources timelineDisplay a timeline of resource activityDetails
mr resources versions-cleanupClean up old versions across resourcesDetails
mr searchSearch across all entitiesDetails
mr seriesManage resource series (list, create, edit, delete)Details
mr series createCreate a new seriesDetails
mr series deleteDelete a series by IDDetails
mr series editEdit a seriesDetails
mr series edit-nameEdit a series nameDetails
mr series getGet a series by IDDetails
mr series listList seriesDetails
mr series remove-resourceRemove a resource from its seriesDetails
mr tagGet, create, edit, or delete a tagDetails
mr tag createCreate a new tagDetails
mr tag deleteDelete a tag by IDDetails
mr tag edit-descriptionEdit a tag's descriptionDetails
mr tag edit-nameEdit a tag's nameDetails
mr tag getGet a tag by IDDetails
mr tagsList, merge, or bulk-delete tagsDetails
mr tags deleteDelete multiple tagsDetails
mr tags listList tagsDetails
mr tags mergeMerge tags into a winnerDetails
mr tags timelineDisplay a timeline of tag activityDetails