Skip to main content
On this page

Kater CLI Make and compare

kater start

See what Kater can make, a type's choices, or what you have for a goal.

kater start lists the goal shapes and each kind with its types. kater start KIND TYPE lists the type’s choices: each one’s options, the recommended one first, what --set set, the first line of the prompt, and the kater new line that makes it. kater start goal --shape SHAPE finds the metric, the dashboards that chart it and the apps and workflows that read them: run it before you make anything for a goal.

Examples

Terminal window
# See what Kater can make, a type's choices, or what you have for a goal
kater start

Arguments

ArgumentDescription
<kind>Optional. app, dashboard, query, chart, project or workflow, or goal. Left out: the goals and what Kater can make.
<type>Optional. The type or template, such as deck or overview. Left out: the kind’s types.

Options

OptionDescription
--set <set-value>A choice the person already set, as CHOICE=VALUE, such as numbers=static. For a goal, a slot, such as metric=return_per_dollar. Repeat it for each. You can give it more than one time.
--shape <shape>With goal: the goal’s shape, such as target, why, update, watch or test.
--metric <metric>With goal: the metric the goal is about, by its name or its label.
--timezone <timezone>The person’s time zone, such as America/New_York, which a schedule’s words name. Left out: this computer’s.

It also takes the global options --json and --help.

See also