Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Ricky is designed around co-equal interfaces and onboarding surfaces. Current im
- **CLI** β€” implemented as the primary local command surface.
- **Local / BYOH** β€” implemented for local workflow generation, artifact execution, background monitoring, and status checks.
- **Cloud API** β€” partially implemented for Cloud generation request/response contracts and CLI connection/status flows.
- **Proactive runtime agent** β€” implemented for scheduled background-run monitoring via `@agent-relay/agent`.
- **Slack** β€” planned; no source handler is currently implemented in this repo.
- **Web** β€” planned; no browser surface is currently implemented in this repo.

Expand Down Expand Up @@ -102,6 +103,22 @@ ricky status --run <run-id>

When generation does not run the artifact, the CLI prints the artifact path plus foreground and background run commands.

## Proactive Runtime Monitoring

Ricky now exposes a proactive runtime entrypoint at [`src/agent.ts`](./src/agent.ts). The scheduled agent wakes every 5 minutes with `agent({ schedule: "*/5 * * * *" })`, scans Ricky's persisted background-run state, and posts terminal run updates to `RICKY_MONITOR_CHANNEL` (default `#ricky`).

Environment knobs for the scheduled agent:
- `RICKY_WORKSPACE_ID` β€” Relaycast/relayfile workspace name for the agent runtime. Defaults to `ricky`.
- `RICKY_MONITOR_CHANNEL` β€” channel that receives proactive run updates. Defaults to `#ricky`.
- `RICKY_MONITOR_REPO_ROOT` β€” repo root whose persisted run-state tree should be monitored. Defaults to the current working directory. Both `<repo>/.workflow-artifacts/ricky-local-runs/` and the XDG state-home tree are scanned.
- `RICKY_STATE_HOME` β€” optional override for the base state directory Ricky already uses for background runs.

Run it locally with:

```sh
tsx src/agent.ts
```

## CLI Onboarding

Ricky's CLI should be intentionally welcoming and user-friendly.
Expand Down
Loading
Loading