Skip to main content
On this page

Kater CLI Present and share dashboard text

kater dashboard text add

Put a text tile on a workspace's dashboard, with words in Markdown.

The text goes right after or before a chart with --after or --before, or at the end of the board. Use it on a report for a fixed time window: an opening summary, a short finding beside each chart, and what to check next at the end. kater dashboard save changes or removes a text tile.

Examples

Terminal window
# Put a text tile on a workspace's dashboard, with words in Markdown
kater dashboard text add

Arguments

ArgumentDescription
<workspace>Optional. The workspace’s path. Left out, the one kater scope use saved.

Options

OptionDescription
--file <file>The words in Markdown, UTF-8; - reads stdin. Each figure is a <kater-value query=“<workspace path>/<query name>” field=“<field>” row=“<n>”></kater-value> tag, never a typed number. The default is -.
--after <after>A chart on the board the text goes right after.
--before <before>A chart on the board the text goes right before, as an opening summary goes before the first chart.
--tab <tab>The tab, on a dashboard with tabs. --after and --before give the chart’s.
--section <section>The section the text goes at the end of. --after and --before give the chart’s.
--span <number>How many of the board’s 12 columns the text takes. All 12 when left out.
--height <number>The height in pixels, a multiple of 16 from 48. Left out, the board draws the text as tall as its words. Give it only to make the tile taller than its words.
--cardDraw the words on a card, as a chart tile is. Without it they draw as plain words on the page.

It also takes the global options --json, --kater-root, --scope and --help.

See also