fix: rename overview.md files to avoid conflicts and add collection name

This commit is contained in:
Timur Gordon
2025-11-14 11:01:43 +01:00
parent f67296cd25
commit 2c24b120de
20 changed files with 85 additions and 91 deletions

View File

@@ -4,16 +4,16 @@ A specialized runner for the Hero ecosystem that executes heroscripts using the
## Overview
The Hero runner executes heroscripts by calling `hero run -h <payload>` for each job. This makes it ideal for:
The Hero runner executes heroscripts by piping the payload to `hero run -s` via stdin for each job. This makes it ideal for:
- Running heroscripts from job payloads
- Executing Hero automation tasks
- Executing Hero automation tasks (e.g., `!!git.list`, `!!docker.start`)
- Integrating with the Hero CLI ecosystem
- Running scripted workflows
## Features
- **Heroscript Execution**: Executes `hero run -h <payload>` for each job
- **Heroscript Execution**: Pipes payload to `hero run -s` via stdin (no temp files)
- **Environment Variables**: Passes job environment variables to the hero command
- **Timeout Support**: Respects job timeout settings
- **Signature Verification**: Verifies job signatures before execution
@@ -38,15 +38,28 @@ herorunner my-hero-runner --redis-url redis://localhost:6379
## Job Payload Format
The job payload should contain the heroscript content that will be passed to `hero run -h`.
The job payload should contain the heroscript content. The runner will pipe it directly to `hero run -s` via stdin.
### Example Payload
### Example Payloads
**Simple print:**
```
print("Hello from heroscript!")
```
The runner will execute: `hero run -h 'print("Hello from heroscript!")'`
**Hero actions:**
```
!!git.list
```
**Multi-line script:**
```
!!git.list
print("Repositories listed")
!!docker.ps
```
The runner executes: `echo "<payload>" | hero run -s`
## Examples