Skip to main content
On this page

Kater CLI Make and compare new

kater new workflow

Make a workflow in your own folder, in one commit.

--start snapshot makes one that saves an app’s numbers and words on a schedule; --start general runs the steps you write. Show the person its steps and its schedule, and make it only after they say yes. Mention each object a step works with as @Name.

Examples

Terminal window
# Make a workflow in your own folder, in one commit
kater new workflow <name>

Arguments

ArgumentDescription
<name>The workflow’s name, such as Monday paid media.

Options

OptionDescription
--app <app>App: with --start snapshot, the app whose snapshots it writes, by its id or its folder, such as users/<email>/apps/weekly_deck. An app has one snapshot workflow.
--cron <cron>Schedule: when it runs, as a cron, such as “0 8 * * 1” for every Monday at 8:00 AM, “0 8 * * 1-5” for every weekday, “0 8 * * 5” for every Friday or “0 8 1 * *” for the first of each month. Without one, the workflow runs only when someone asks, such as a snapshot workflow that keeps one snapshot now.
--timezone <timezone>The cron’s time zone, such as America/New_York. Left out: this computer’s time zone, or UTC where it has none.
--channel <channel>With --start snapshot: the Slack channel id the run posts in.
--file <file>The steps, as Markdown with mentions; - reads them from stdin. The default is -.
--start <start-type>The type to start from: snapshot, general. Left out: a plain page.

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

See also