Skip to content

Commit d3cb232

Browse files
committed
Document scheduled task creation through the UI and chat
Add a complete Scheduled Tasks guide with real form and chat examples, six framed screenshots, schedule fields, task conversations, controls, and catch-up behavior. Link it from the docs index, Usage, and A0Cleaner, and correct the Cleaner timezone instructions. Verified both creation paths on localhost:32081, ran the form-created task, checked edit/reset/delete controls, and removed the demo tasks. Validated local links, matching website text, image dimensions, and rendered screenshots. Document the current lack of a Stop button for scheduler runs.
1 parent 7027b96 commit d3cb232

11 files changed

Lines changed: 186 additions & 32 deletions

‎docs/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- `guides/onboarding.md` covers provider selection and completion: the final Continue action closes the wizard and keeps the existing chat. Keep its Codex Main/Utility suggestions aligned with OAuth provider metadata.
2222
- `guides/telegram.md` owns private-bot setup, access versus administrator lists, scoped bot ownership, groups, webhooks, and upgrade recovery. Keep it aligned with the website Telegram guide and the bundled plugin; captures under `res/usage/telegram/` show unsaved neutral drafts with complete dialog frames and breathing room, never credentials.
2323
- `guides/cleaner.md` owns A0Cleaner's automatic defaults, notifications, scheduling, manual review, and custom folders. Keep it aligned with the website Cleaner guide and bundled plugin. Captures under `res/usage/cleaner/` retain complete panels; the toast uses a saved maintenance result and the custom-folder example is unsaved. Link the guide from the docs index and Usage.
24+
- `guides/task-scheduler.md` owns end-to-end form and natural-chat task creation, cron fields, dedicated/shared conversations, task controls, and missed runs. Keep it aligned with the website Task Scheduler guide and current controls; do not imply Reset State starts/stops work or that scheduled chats expose the ordinary Stop button. Captures under `res/usage/tasks/` show neutral example tasks with complete forms and dialogs. Link it from the docs index, Usage, and A0Cleaner.
2425
- Shared Web UI captures under `res/usage/webui/` must show real, optimized, neutral demo state without personal paths, account identities, or community controls presented as built-in features.
2526

2627
## Local Contracts

‎docs/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ docs focus on practical setup, screenshots, and user workflows.
2626
- **[OpenCode Go and Provider Plugins](guides/opencode.md):** Find a missing provider in the Plugin Hub, install OpenCode Go, and choose Main and Utility models.
2727
- **[Migrate Agents](guides/migrate-agents.md):** Move real Pi, Hermes Agent, and Claude Code chats, copy their working files, and continue the project in Agent Zero.
2828
- **[Usage Guide](guides/usage.md):** Practical tour of Agent Zero's main workflows.
29+
- **[Scheduled Tasks](guides/task-scheduler.md):** Create a recurring task with the form or a normal chat request, find its conversation, and manage later runs.
2930
- **[Agent Zero Launcher](guides/launcher.md):** Fresh-machine setup, Installs, Instances, and workspace folder or Docker volume choices.
3031
- **[Use Local Folders With Agent Zero](guides/local-folders.md):** Bind mounts, persistent user data, separate work folders, Docker CLI/Desktop/Compose examples, and Launcher storage links.
3132
- **[First-Run Onboarding](guides/onboarding.md):** Set up OpenRouter, our proxy API or another provider with the guided wizard.
@@ -128,6 +129,7 @@ docs focus on practical setup, screenshots, and user workflows.
128129
- [File Browser](guides/usage.md#file-browser)
129130
- [Memory Management](guides/usage.md#memory-management)
130131
- [Backup And Restore](guides/usage.md#backup-and-restore)
132+
- [Scheduled Tasks](guides/task-scheduler.md)
131133
- [Agent Zero Launcher](guides/launcher.md)
132134
- [Workspace Storage](guides/launcher.md#workspace-storage)
133135
- [Use Local Folders With Agent Zero](guides/local-folders.md)

‎docs/guides/cleaner.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,9 @@ Under **Automatic care**, choose **Daily**, **Weekly**, **Monthly**, or **Off**.
9090
The presets run at 09:00: weekly on Monday, monthly on the first day of the month.
9191

9292
Select the sliders button, **Schedule details**, to open the **A0Cleaner** task.
93-
Use **Edit** to change its time, timezone, or cron schedule. You can also find
94-
it in Agent Zero's [Tasks](usage.md#tasks-and-scheduling).
93+
Use **Edit** to change its time or cron schedule. For a different timezone,
94+
ask the agent to update the A0Cleaner task. You can also find it in
95+
[Scheduled Tasks](task-scheduler.md).
9596

9697
- To keep scheduled scans and notifications but decide on every deletion,
9798
turn **Automatic cleanup** off and leave the schedule on.

‎docs/guides/task-scheduler.md‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# Create a scheduled task
2+
3+
Ask Agent Zero to do something on a schedule, then come back to its results.
4+
You can create a task in **Scheduled Tasks** or describe what you want in a
5+
normal chat. Both methods save it in the same task list.
6+
7+
This guide uses two examples: Sunday dinner ideas created with the form, and
8+
a weekday writing warm-up created through chat.
9+
10+
- [Open Scheduled Tasks](#open-scheduled-tasks)
11+
- [Create a task with the form](#create-a-task-with-the-form)
12+
- [Create a task through chat](#create-a-task-through-chat)
13+
- [Find the task and its conversation](#find-the-task-and-its-conversation)
14+
- [Run, pause, edit, or delete a task](#run-pause-edit-or-delete-a-task)
15+
- [Check timing and missed runs](#check-timing-and-missed-runs)
16+
17+
## Open Scheduled Tasks
18+
19+
Open **More options**, the dropdown arrow at the top of the sidebar, then
20+
select **Scheduled Tasks**. The modal lists saved tasks and their states.
21+
22+
![Sidebar dropdown with Scheduled Tasks](../res/usage/tasks/open-scheduled-tasks.png)
23+
24+
Select **New Task** to open the creation form.
25+
26+
## Create a task with the form
27+
28+
Let's set up dinner ideas for Sunday at 18:00. Fill in these fields:
29+
30+
| Field | What to enter |
31+
| --- | --- |
32+
| **Task Name** | `Sunday meal ideas`, or another name you will recognize. |
33+
| **Type** | **Scheduled (Cron)** for a repeating task. |
34+
| **Project** | **No project** for this example. Choose a project if the task needs its files, instructions, or connections. The form initially uses the active chat's project. |
35+
| **State** | **Idle (ready to run)**. Choose **Disabled** if you want to save it without enabling scheduled runs yet. |
36+
| **Schedule** | Minute `0`, Hour `18`, Day `*`, Month `*`, Weekday `0`. |
37+
| **System Prompt** | Optional guidance for how to respond. For example: “Keep suggestions practical and use everyday ingredients.” |
38+
| **User Prompt** | The work to do each time. Use the dinner request below. |
39+
| **Attachments** | Optional file paths inside Agent Zero or URLs, one per line. Leave empty for this example. |
40+
41+
For **User Prompt**, enter:
42+
43+
> Suggest three easy vegetarian dinners for two for the coming week. Keep each
44+
> recipe under 30 minutes and give me one combined shopping list.
45+
46+
Put the timing in **Schedule** and the work in **User Prompt**. The task's
47+
prompt should ask for the dinners, not ask Agent Zero to create another task.
48+
Use **Expand** beside either prompt if you need more room to write.
49+
50+
![Completed task form for Sunday meal ideas, including the schedule, prompts, attachments, and Save](../res/usage/tasks/create-recurring-task.png)
51+
52+
### Read the five schedule fields
53+
54+
The fields run from left to right: **Minute, Hour, Day, Month, Weekday**.
55+
`*` means every value in that field. Hours use the 24-hour clock, and weekday
56+
`0` means Sunday; `1` through `6` mean Monday through Saturday.
57+
58+
| When | Minute | Hour | Day | Month | Weekday |
59+
| --- | --- | --- | --- | --- | --- |
60+
| Every day at 09:00 | `0` | `9` | `*` | `*` | `*` |
61+
| Weekdays at 08:30 | `30` | `8` | `*` | `*` | `1-5` |
62+
| Sundays at 18:00 | `0` | `18` | `*` | `*` | `0` |
63+
64+
**Five asterisks means every minute.** Replace the fields before saving.
65+
New tasks use the timezone in **Settings → Agent → Locale**. With **Automatic
66+
(browser)** selected, that comes from your browser.
67+
68+
For a one-time job, choose **Planned (Specific Times)**, pick the date and time,
69+
and select **Add Time** before saving. You can add more than one date.
70+
**Ad-hoc (Manual)** saves a task you run on demand, without a repeating schedule.
71+
72+
### Save and check it
73+
74+
Select **Save**. The form closes and **Sunday meal ideas** appears in the list.
75+
**Idle** means ready for its next scheduled run; saving it does not run it
76+
immediately.
77+
78+
![Saved Sunday meal ideas task in the Scheduled Tasks list, with Idle selected in the state filter](../res/usage/tasks/saved-task-list.png)
79+
80+
Click its row to inspect the saved details. To try it now, select the triangle
81+
button, **Run Task**, or **Run** inside Task Details. Open its conversation from
82+
the sidebar **Tasks** section to watch the work and read the result.
83+
84+
## Create a task through chat
85+
86+
You can skip the form and ask in your own words. For example:
87+
88+
> Every weekday at 8:30 in the morning, give me a quick writing warm-up: a fun
89+
> prompt I can finish in ten minutes and one tip to help me start. Keep these
90+
> in their own chat so I can find them easily.
91+
92+
Send this in a normal chat. If you want the task to belong to a project, open
93+
a chat in that project first. Mention a timezone if the time should be
94+
different from your Agent Zero setting.
95+
96+
![A real chat request for a weekday writing warm-up and Agent Zero's confirmation of the saved task](../res/usage/tasks/create-from-chat.png)
97+
98+
Wait for Agent Zero to confirm that it created the task. Then open
99+
**More options → Scheduled Tasks** and find **Writing warm-up**. Click its row
100+
to check the saved schedule and instructions. In this example, the schedule is
101+
`30 8 * * 1-5`: weekdays at 08:30.
102+
103+
![Task Details for the chat-created Writing warm-up, with its saved schedule and prompts](../res/usage/tasks/task-details.png)
104+
105+
The wording of the confirmation can vary. The saved task is what tells you
106+
the automation exists. If Agent Zero asks a follow-up question, answer it and
107+
check the list once creation is confirmed.
108+
109+
## Find the task and its conversation
110+
111+
**Scheduled Tasks** is the complete list. Use its **Type** and **State** filters
112+
to narrow it down. If a task seems missing, return to **All Types** and
113+
**All States**.
114+
115+
Tasks with a **dedicated chat** also appear under **Tasks** in the sidebar.
116+
Expand that section if it is collapsed, then select a task's name to open its
117+
conversation. Both the form and the agent normally create dedicated chats;
118+
each task's results stay together across runs.
119+
120+
![Sidebar Tasks section containing Writing warm-up and Sunday meal ideas](../res/usage/tasks/sidebar-task-chats.png)
121+
122+
If you ask Agent Zero to run a task in the current conversation instead, its
123+
results stay in that shared chat under **Chats**. The task still appears in
124+
**Scheduled Tasks**, but it does not get a separate sidebar task entry.
125+
126+
Plugin tasks such as [A0Cleaner](cleaner.md) can also appear in Scheduled Tasks.
127+
They run the plugin's operation and do not need a task conversation.
128+
129+
## Run, pause, edit, or delete a task
130+
131+
Click a task's row for **Task Details**, including its schedule, **Last Run**,
132+
**Last Result**, and saved prompts. For the ongoing conversation, select its
133+
sidebar task entry.
134+
135+
| What you want | What to use |
136+
| --- | --- |
137+
| Run it now or run it again | **Run Task** (triangle) in the list, or **Run** in Task Details. A disabled task must be enabled first. |
138+
| Pause the agent's current work | Open its conversation and select **Pause Agent**. Use **Resume Agent** to continue. |
139+
| Stop future scheduled runs | **Edit Task** (pencil), choose **Disabled**, then **Save**. This does not cancel work already running. |
140+
| Enable it again | Edit its state to **Idle** and save. |
141+
| Change the prompt or schedule | **Edit Task**, update the fields, then **Save**. The task's type and project cannot be changed in this editor. |
142+
| Make an interrupted task ready again | **Reset State** (circular arrow) returns it to **Idle**. It does not run the task or clear its conversation. |
143+
| Delete it | **Delete Task** (trash), then click the confirmation checkmark. Deleting a dedicated task also removes its task chat. |
144+
| Clear its conversation | **Clear task chat** in the sidebar. This erases the task's chat history while keeping its definition. It is not needed for an ordinary rerun. |
145+
146+
Scheduled runs currently do not show the regular **Stop agent** button.
147+
Use **Pause Agent** when you need to interrupt the agent without deleting its
148+
conversation. Resetting a state is not a way to stop work that is still running.
149+
150+
The state badges help you see what needs attention: **Idle** is ready,
151+
**Running** is executing, **Disabled** is switched off, and **Error** needs a
152+
look at the result or chat. Use **Run Task** to start work; selecting a state
153+
label does not start an agent run.
154+
155+
## Check timing and missed runs
156+
157+
Agent Zero needs to be running to do the work. If a recurring task misses its
158+
time while the container is off, an enabled, idle task catches up once after
159+
startup. Several missed occurrences become one run, then the normal schedule
160+
resumes. Disabled or failed tasks do not catch up automatically, and a run
161+
interrupted by shutdown needs your attention.
162+
163+
Changing a recurring schedule or re-enabling a task starts its timing from
164+
that change. Existing tasks keep their saved timezone; changing Locale does
165+
not rewrite them. You can ask in chat, for example, “Change my writing warm-up
166+
to 8:30 London time.”
167+
168+
Try the work once before relying on it unattended. A scheduled inbox summary
169+
still needs a working email connection, and a task that uses an AI model uses
170+
your normal model account and settings. Its results appear in Agent Zero;
171+
delivery to email or another app needs to be part of the request and configured.

‎docs/guides/usage.md‎

Lines changed: 9 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -327,39 +327,18 @@ See the [Projects guide](projects.md) for the full screenshot walkthrough.
327327

328328
Tasks let Agent Zero run work later, repeatedly, or on demand.
329329

330-
Use tasks for:
330+
Open the sidebar's **More options → Scheduled Tasks**, select **New Task**, fill
331+
in the form, and **Save**. You can also ask in a normal chat, for example:
331332

332-
- morning or weekly reports;
333-
- monitoring a source and summarizing changes;
334-
- recurring cleanup or export jobs;
335-
- project-specific checks;
336-
- manual batch jobs you want to run again.
333+
> Every weekday at 8:30 in the morning, give me a quick writing warm-up: a fun
334+
> prompt I can finish in ten minutes and one tip to help me start. Keep these
335+
> in their own chat so I can find them easily.
337336
338-
Open **Tasks** from the dashboard or sidebar.
337+
Both methods save the task in **Scheduled Tasks**. A task with its own chat
338+
also appears under **Tasks** in the sidebar, where you can read its results.
339339

340-
![Task scheduler](../res/usage/tasks/scheduler-1.png)
341-
342-
When creating a task, focus on four things:
343-
344-
- **Name:** what you will recognize later.
345-
- **Type:** scheduled, planned, or ad-hoc.
346-
- **Project:** optional, but recommended when the task needs specific context or secrets.
347-
- **Prompt:** the actual work Agent Zero should perform.
348-
349-
![Edit task](../res/usage/tasks/edit-task.png)
350-
351-
Example:
352-
353-
```text
354-
Name: Weekly docs review
355-
Type: Scheduled
356-
Project: Documentation
357-
Prompt: Check the docs project for stale screenshots, broken links, and confusing sections. Summarize what needs attention.
358-
```
359-
360-
Project-scoped tasks inherit project instructions, variables, secrets, files, and
361-
memory. That means you can improve task behavior later by improving the project
362-
instead of repeating every rule in every task.
340+
Follow [Create a scheduled task](task-scheduler.md) for both complete
341+
walkthroughs, schedule examples, task controls, and what happens after downtime.
363342

364343
## Secrets And Variables
365344

22.2 KB
Loading
35.4 KB
Loading
8.99 KB
Loading
17.3 KB
Loading
3.92 KB
Loading

0 commit comments

Comments
 (0)