Scheduled agents
Automate recurring documentation tasks with scheduled agents that run on a defined cadence.
Scheduled agents run prompts automatically on a recurring schedule. Use them to generate release notes every week, audit documentation monthly, or run any repeatable documentation task without manual intervention.
Before you begin
Section titled “Before you begin”You need:
- An EkLine account with Docs Agent enabled.
- At least one repository connected to EkLine.
Create a scheduled agent
Section titled “Create a scheduled agent”-
Click Scheduled Agents in the left navigation.
-
Click New Agent.
-
Enter an Agent Name that describes the task (for example,
Weekly Release Notes). -
Select a Prompt Type:
- Custom Prompt — Write your own prompt that runs on each execution.
- Predefined Template — Select from available templates like Release Notes Generator.
-
Configure the Schedule by selecting a frequency and time.
-
Click Create Agent.
The agent appears in the Scheduled Agents list and runs automatically at the next scheduled time.
Choose a schedule
Section titled “Choose a schedule”The schedule picker supports four frequencies. All times display in your local timezone.
| Frequency | Options | Example |
|---|---|---|
| Hourly | Runs every hour | Every hour, on the hour |
| Daily | Select the time of day | Every day at 9:00 AM |
| Weekly | Select the day and time | Every Monday at 9:00 AM |
| Monthly | Select the day of month and time | 1st of every month at 9:00 AM |
Write effective prompts
Section titled “Write effective prompts”Custom prompts run exactly as written on every scheduled execution. Write them to be self-contained and repeatable.
Generate release notes for all tickets completed since thelast release. Organize by Features, Improvements, and BugFixes. Write for end users.Review the docs/ directory for outdated content. Flag anyreferences to deprecated APIs or removed features. Createa summary of what needs updating.Check if the README reflects the current project structureand dependencies. Update any outdated installationinstructions or configuration examples.Use predefined templates
Section titled “Use predefined templates”Templates provide pre-built prompts for common documentation tasks. Select Predefined Template when creating an agent and choose from the available options.
| Template | Description |
|---|---|
| Release Notes Generator | Generates release notes from completed tickets, grouped by category |
EkLine maintains templates and updates them as new automation patterns become available.
Manage your agents
Section titled “Manage your agents”Enable or disable an agent
Section titled “Enable or disable an agent”Toggle the switch next to any agent in the Scheduled Agents list to enable or disable it. Disabled agents keep their configuration but stop running until re-enabled.
Edit an agent
Section titled “Edit an agent”-
Click the actions menu (three dots) on the agent row.
-
Select Edit.
-
Update the name, prompt, or schedule.
-
Click Save Changes.
Delete an agent
Section titled “Delete an agent”-
Click the actions menu (three dots) on the agent row.
-
Select Delete.
-
Confirm the deletion in the dialog.
View run history
Section titled “View run history”Expand any agent row in the Scheduled Agents list to see its recent runs. Each run shows:
| Element | Description |
|---|---|
| Status icon | Whether the run succeeded, failed, or is still running |
| Timestamp | When the run started — click to open the editor session with the generated output |
Run history displays the five most recent executions, sorted from newest to oldest.
Run statuses
Section titled “Run statuses”| Status | Meaning |
|---|---|
| Succeeded | The agent completed the prompt and generated output |
| Failed | The agent encountered an error during execution |
| Running | The agent is currently executing |
Next steps
Section titled “Next steps”- Create documentation — Generate READMEs, API references, and guides with custom prompts.
- Update and review — Keep documentation in sync with code changes.
- Integrations — Pull content from Slack, Notion, Linear, and more.