Skip to content

Commit

Permalink
docs; Update schedules cli reference
Browse files Browse the repository at this point in the history
  • Loading branch information
daryllimyt committed Jul 2, 2024
1 parent ba2c791 commit 82fa8c8
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/concepts/schedules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Tracecat allows you to use schedules to automatically create new workflow runs.
A Schedule contains information that Tracecat uses to execute workflows for you automatically on a specified cadence.
You can add multiple schedules to any workflow. The Tracecat scheduler (built on Temporal) periodically reviews every workflow and executes them according to their configued schedule.

Find the CLI reference for schedules [here](/using-the-cli/#schedules-management).

## Creating a schedule

Schedules use [ISO8601 duration](https://www.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) strings to specify the schedule interval.
Expand Down
50 changes: 50 additions & 0 deletions docs/using-the-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,52 @@ Delete a secret from Tracecat's secret manager.
tracecat secrets delete SECRET_NAME
```
## Schedules Management
### Creating schedules
```
tracecat schedule create WORKFLOW_ID
```
| Arguments | Type | Description | Default | Required |
| ------------- | ---- | ----------- | ------- | -------- |
| `workflow_id` | TEXT | Workflow ID | None | Yes |
| Options | Short | Type | Description | Default |
| ---------- | ----- | ---- | ----------------------------------------- | ------- |
| `--data` | `-d` | TEXT | JSON Payload to send (trigger context) | None |
| `--every` | `-e` | TEXT | Interval at which the schedule should run | None |
| `--offset` | `-o` | TEXT | Offset from the start of the interval | None |
### Listing schedules
```
traceat schedule list
```
### Updating schedules
```
tracecat schedule update SCHEDULE_ID [OPTIONS]
```
| Arguments | Type | Description | Default | Required |
| ------------- | ---- | ----------- | ------- | -------- |
| `schedule_id` | TEXT | Schedule ID | None | Yes |
| Options | Short | Type | Description | Default |
| ---------- | ----- | ---- | ----------------------------------------- | ------- |
| `--data` | `-d` | TEXT | JSON Payload to send (trigger context) | None |
| `--every` | `-e` | TEXT | Interval at which the schedule should run | None |
| `--offset` | `-o` | TEXT | Offset from the start of the interval | None |
### Deleting schedules
```
tracecat schedule delete [SCHEDULE_ID]
```
## Dev commands
Provides development tools for managing API interactions, generating specifications, and more.
Expand All @@ -305,3 +351,7 @@ Provides development tools for managing API interactions, generating specificati
| `generate-spec` | Generate OpenAPI specification. Requires npx. |
| `generate-udf-docs` | Generate UDF documentation. |
| `whoami` | Print the current role of the authenticated user. |
```

```

0 comments on commit 82fa8c8

Please sign in to comment.