> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kanaeru.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Automations

> Run Kana on a schedule, from an API call, or in response to a signed webhook.

An automation is a saved prompt that Kanaeru runs for you when its trigger fires. Use one for recurring work like a nightly dependency check, a weekly report, or reacting to events in another system.

## Triggers

| Trigger | Fires when |
| - | - |
| **Schedule** | A cron expression matches, in the timezone you choose |
| **API** | Something calls the automation's endpoint with its API key. See [Trigger an automation](/api/introduction) |
| **Webhook** | A signed webhook arrives that matches the event filters you set |

## Create an automation

Open **Automations** from the user menu, or **Settings** from a workspace's menu, to see that workspace's automations on its settings page. Create one there, or ask Kana in chat to set one up. Kana can draft the automation for you, but every new automation is created **disabled**: you review it and enable it yourself.

An automation has:

* A **name**, an optional **description**, and the **prompt** to run.
* A **trigger**.
* An **Execution mode**: it runs on your own machine with Claude Code or Codex.
* An **Automation session**, which picks the kind of Kana session the prompt runs as, such as a native session, a Koa session, or a planning or retrospective session.
* **Who it is for**: **Just me**. **Team** is listed but can't be chosen yet, because it needs a machine your team shares and every machine belongs to one person today.

<Note>
  Automations run on the creator's agent machine, so that machine must be connected when a run fires. A run waits for its machine if the machine is busy or offline. Only the creator can move an automation to another machine.
</Note>

An automation created inside a workspace belongs to that workspace. Kana can also create one without a workspace, which applies across your organization; the link she gives you opens the organization-wide **Automations** page.

Only an automation's creator, or an owner or admin, can change it. Anyone else can open it and choose **Save as my copy** to get their own copy, for just them, on their own machine. The copy starts disabled, and the original stays as it is.

## Runs

Each firing creates a run that moves through **pending**, **waiting for a machine**, **running**, and then **completed**, **failed**, or **cancelled**. A run that needs your input pauses at **needs input**. Every automation keeps its run history.

To test an automation without enabling it, choose **Run** to trigger it once.

## From the terminal

```bash theme={null}
kana automations list
kana automations create --file nightly-deps.json
kana automations trigger <automation-id>
kana automations runs <automation-id>
kana automations enable <automation-id>
```

See [`kana automations`](/cli/reference#kana-automations).


## Related topics

- [Command reference](/cli/reference.md)
- [API introduction](/api/introduction.md)
- [Settings and profile](/guides/settings.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.