Skip to main content

mr note-type edit

Edit a note type. --id is required; every other flag is optional and only fields explicitly passed are modified (server-side PATCH semantics). Use this command when you need to change the MetaSchema, SectionConfig, or any of the Custom* rendering fields -- there is a --custom-* flag for each template slot, listed with a one-line description of where it renders under mr note-type edit --help. The dedicated edit-name / edit-description commands only touch those two scoped fields. --custom-css is injected as a <style> block on detail and list pages.

Because only explicitly-passed flags are sent, passing a --custom-* flag with an empty string is how a slot is cleared; omitting it leaves the stored value alone. --section-config "" is the exception: an empty section config is ignored rather than stored, so a section config cannot be cleared from the CLI.

Usage

mr note-type edit

Examples

Swap the JSON Schema on note type 1

mr note-type edit --id 1 \
--meta-schema '{"type":"object","properties":{"priority":{"type":"string"}}}'

Update the custom summary template and confirm via list

mr note-type edit --id 1 --custom-summary "<div>{{ Note.Name }}</div>"
mr note-types list --json | jq '.[] | select(.ID == 1).CustomSummary'

Flags

FlagTypeDefaultDescription
--iduint0Note type ID (required) (required)
--namestring``Note type name
--descriptionstring``Note type description
--meta-schemastring``JSON Schema defining the metadata structure for notes of this type
--section-configstring``JSON controlling which sections are visible on note detail pages
--custom-headerstring``Rendered at the top of the note detail page
--custom-detail-footerstring``Rendered at the bottom of the note detail page, below every built-in section
--custom-sidebarstring``Rendered in the note detail page sidebar
--custom-summarystring``Rendered on note cards in list views, below the title
--custom-avatarstring``Replaces the default avatar on note cards
--custom-hover-cardstring``Rendered in the hover card for a note link; falls back to --custom-summary when unset
--custom-list-headerstring``Rendered above note list pages filtered to exactly this note type, against the note type itself
--custom-list-footerstring``Rendered below note list pages filtered to exactly this note type, against the note type itself
--custom-mrql-resultstring``Template for rendering notes of this note type in MRQL results
--custom-cssstring``CSS injected as a <style> block on the note detail page and its list pages

Inherited global flags

FlagTypeDefaultDescription
--jsonboolfalseOutput raw JSON
--no-headerboolfalseOmit table headers
--pageint1Page number for list commands (default page size: 50)
--quietboolfalseOnly output IDs
--serverstringhttp://localhost:8181mahresources server URL (env: MAHRESOURCES_URL)

Output

Updated NoteType with ID, Name, Description, MetaSchema, SectionConfig, CustomHeader/DetailFooter/Sidebar/Summary/Avatar/HoverCard/ListHeader/ListFooter/MRQLResult/CSS, ApplyTemplatesToShares, CreatedAt, UpdatedAt

Exit Codes

0 on success; 1 on any error

See Also