@gorombo/gorombo-skill-harvester
v0.1.3
Published
Durable Codex skill harvesting with Telegram and selected-task delivery.
Downloads
280
Maintainers
Readme
Gorombo Skill Harvester
Gorombo Skill Harvester turns completed Codex work into durable, human-readable skill recommendations. It can deliver each recommendation through Telegram, to one selected Codex task, or to both. The Telegram route can also accept authorized text tasks and return their results.
Gorombo Skill Harvester is available as the public npm package
@gorombo/gorombo-skill-harvester.
What it does
- Detects successful Codex goal completions through the included plugin hook.
- Assesses completed work for reusable skill opportunities.
- Saves each proposed skill as a readable Markdown recommendation.
- Delivers useful alerts with the skill name, purpose, reason, use cases, suggested procedure, and next action.
- Supports Telegram alerts and tasks, a selected Codex task destination, or both routes together.
- Persists recommendations, delivery work, attempts, and receipts for restart recovery.
- Runs as an always-on user service after onboarding; no terminal needs to remain open.
The completion path is event-driven:
Codex goal completes
-> completion hook commits a private handoff
-> Gorombo Skill Harvester assesses the completed work
-> a proposed skill is saved as Markdown
-> each selected route receives a readable alertRequirements
- Node.js 22.13.0 or newer.
- An authenticated stable Codex CLI 0.147.0 or newer, available to the user running Gorombo Skill Harvester.
- A Telegram bot token and Telegram user ID only when the Telegram route is selected.
Quick start
1. Install the public package
npm install --global @gorombo/gorombo-skill-harvester
gorombo-skill-harvester preflight --jsonThe global install provides the gorombo-skill-harvester command and the packaged Codex plugin files. For repository development and verification, see Development.
If upgrading from the previous product identity, stop and uninstall its user service first, then preserve the existing state with:
gorombo-skill-harvester migrate --confirmThe migration moves the existing private state directory as one atomic operation. It does not rewrite <CODEX_HOME>/.gorombo/.env; previous HARVESTER_V2_TASK_* names remain accepted as compatibility aliases, while new setup uses only GOROMBO_SKILL_HARVESTER_TASK_*.
2. Choose a route
| Route | What it provides | Setup |
| --- | --- | --- |
| telegram | Alerts and authorized Telegram text tasks | Add the private Telegram settings, pair the bot, and test the route |
| session | Alerts in one named Codex task | Select or create the task, then test the route |
| both | Independent delivery to Telegram and a Codex task | Complete and test both route setups |
For Telegram, create the private environment file at <CODEX_HOME>/.gorombo/.env using .env.example. Keep real values out of this repository.
TELEGRAM_BOT_TOKEN=replace-with-your-bot-token
TELEGRAM_ALLOWED_USER_IDS=replace-with-your-telegram-user-id
GOROMBO_SKILL_HARVESTER_TASK_CWD=replace-with-the-task-working-directory
GOROMBO_SKILL_HARVESTER_TASK_SANDBOX=read-only
GOROMBO_SKILL_HARVESTER_TASK_MODEL=replace-with-the-model-nameGOROMBO_SKILL_HARVESTER_TASK_MODEL is optional. The task sandbox can be read-only, workspace-write, or danger-full-access; read-only is the default.
3. Onboard and test
Choose one route mode:
gorombo-skill-harvester onboard --route telegram
gorombo-skill-harvester onboard --route session
gorombo-skill-harvester onboard --route bothStart the temporary runtime while completing route setup:
gorombo-skill-harvester serveFor Telegram, send /start to the bot, then approve the six-character code locally and test delivery:
gorombo-skill-harvester pair ABC123
gorombo-skill-harvester route test telegramFor a selected Codex task, choose an existing visible name or create a new one from the desired working directory:
gorombo-skill-harvester session list
gorombo-skill-harvester session select "Gorombo Skill Harvester"
# Or:
gorombo-skill-harvester session create "Gorombo Skill Harvester"
gorombo-skill-harvester route test sessionConfirm readiness, stop the temporary runtime, and install the user service:
gorombo-skill-harvester status --json
gorombo-skill-harvester shutdown
gorombo-skill-harvester service install
gorombo-skill-harvester service status --jsonSee Getting started for the complete route-specific flow.
Using Gorombo Skill Harvester
After the service is ready, successful Codex goal completions are assessed automatically. A propose-new decision creates a recommendation beneath:
<CODEX_HOME>/.gorombo/gorombo-skill-harvester/recommendations/Telegram commands:
- Send normal text to run an authorized Codex task.
- Send
/statusfor safe route and task state. - Send
/cancelto cancel queued work or request cancellation of the running task. - Send
/helpfor the available commands.
Useful local commands:
gorombo-skill-harvester doctor --json
gorombo-skill-harvester status --json
gorombo-skill-harvester service status --json
gorombo-skill-harvester route pause telegram
gorombo-skill-harvester route resume telegram
gorombo-skill-harvester route pause session
gorombo-skill-harvester route resume sessionFile structure
Public repository layout:
.codex-plugin/ Codex plugin manifest
hooks/ Completion hook
skills/gorombo-skill-harvester/ Agent-facing skill and references
src/ CLI and runtime implementation
migrations/ SQLite schema migrations
docs/ Public guides, plans, and specifications
test/ Deterministic test suitePrivate runtime layout:
<CODEX_HOME>/.gorombo/
|-- .env
+-- gorombo-skill-harvester/
|-- config.json
|-- state.sqlite3
|-- completion-spool/
|-- recommendations/
|-- run/
|-- logs/
|-- backups/
+-- recovery/The repository contains no real .env, credential, pairing record, private identity, or machine-specific runtime path.
Documentation
- Documentation hub
- Getting started
- Configuration
- Operations and troubleshooting
- Migration
- Security Policy
- Support
Development
npm run check
npm test
npm run verify
npm pack --dry-run --jsonnpm run verify checks source syntax, validates the skill and package inventory, scans both the GitHub repository candidates and packed public files, runs the deterministic test suite, and verifies an isolated packed installation.
Read CONTRIBUTING.md before opening an issue or pull request. Participation is governed by the Code of Conduct.
Release
Version 0.1.3 is the current public release.
License
Gorombo Skill Harvester is released under the MIT License.
