aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-17 22:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Schedule recipes with the CLI (#2881)

Browse Source
This commit is contained in:
Emma Youndtsmith
2025-06-12 09:35:23 -05:00
committed by GitHub
parent 4686972d3b
commit 298b1254a9
2 changed files with 64 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
documentation/docs/guides/goose-cli-commands.md
View File

@@ -356,6 +356,46 @@ goose recipe deeplink my-recipe.yaml
goose recipe help
```
---
### schedule
Automate recipes by running them on a schedule using a cron job.
**Usage:**
```bash
goose schedule <COMMAND>
```
**Commands:**
- `add <OPTIONS>`: Create a new scheduled job. Copies the current version of the recipe to `~/.local/share/goose/scheduled_recipes`
- `list`: View all scheduled jobs
- `remove`: Delete a scheduled job
- `sessions`: List sessions created by a scheduled recipe
- `run-now`: Run a scheduled recipe immediately
**Options:**
- `--id <NAME>`: A unique ID for the scheduled job (e.g. `daily-report`)
- `--cron "* * * * * *"`: Specifies when a job should run using a 6-field [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) represented as a string in the format "seconds minutes hours day-of-month month day-of-week"
- `--recipe-source <PATH>`: Path to the recipe YAML file
- `--limit <NUMBER>`: (Optional) max number of sessions to display when using the `sessions` command
**Examples:**
```bash
# Add a new scheduled recipe which runs every day at 9 AM
goose schedule add --id daily-report --cron "0 0 9 * * *" --recipe-source ./recipes/daily-report.yaml
# List all scheduled jobs
goose schedule list
# List the 10 most recent Goose sessions created by a scheduled job
goose schedule sessions --id daily-report --limit 10
# Run a recipe immediately
goose schedule run-now --id daily-report
# Remove a scheduled job
goose schedule remove --id daily-report
```
---
### project

30
documentation/docs/guides/session-recipes.md
View File

@@ -167,6 +167,12 @@ Validation ensures that:
- Paste it into your browser's address bar
- You will see a prompt to "Open Goose"
- Goose Desktop will open with the recipe
:::note Privacy & Isolation
- Each person gets their own private session
- No data is shared between users
- Your session won't affect the original recipe creator's session
:::
</TabItem>
<TabItem value="cli" label="Goose CLI">
@@ -323,16 +329,28 @@ Validation ensures that:
</TabItem>
</Tabs>
:::note Privacy & Isolation
- Each person gets their own private session
- No data is shared between users
- Your session won't affect the original recipe creator's session
:::
### Schedule a Recipe
Automate Goose recipes by running them on a schedule.
**Create a schedule** - Create a scheduled cron job that runs the recipe on the specified cadence.
```bash
# Add a new scheduled recipe which runs every day at 9 AM
goose schedule add --id daily-report --cron "0 0 9 * * *" --recipe-source ./recipes/daily-report.yaml
```
The [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) follows the format "seconds minutes hours day-of-month month day-of-week".
See the [`schedule` command documentation](/docs/guides/goose-cli-commands#schedule) for detailed examples and options.
</TabItem>
</Tabs>
:::note Privacy & Isolation
- Each person gets their own private session
- No data is shared between users
- Your session won't affect the original recipe creator's session
:::
## Core Components
A recipe needs these core components: