diff --git a/README.md b/README.md index b2e9471..04b4f4a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,12 @@ This skill does **not** post to X. It only searches for markers you already post - File tools enabled - A local notes/vault folder, such as Obsidian +Optional for Hermes Tweet users: + +- [Hermes Tweet](https://github.com/Xquik-dev/hermes-tweet) +- `XQUIK_API_KEY` +- Leave `HERMES_TWEET_ENABLE_ACTIONS` unset for read-only BotMark ingestion + ## Install ### Option A — copy the skill file @@ -106,6 +112,12 @@ Use: Search for recent public X replies and quote-posts from X_HANDLE containing MARKER_HASHTAG case-insensitively. Resolve parent/original/quoted posts when possible. Dedupe against botmark_state.json and botmark_items.jsonl. Save new items, update state, append BotMark Inbox.md, and report new/already/unresolved counts. Do not post to X. Do not create cron jobs. ``` +## Optional Hermes Tweet Route + +When Hermes Tweet is installed, BotMark can use its read-only tools to search for public marker posts, inspect public parent or quoted posts, and preserve cited X URLs before writing local state. Keep `HERMES_TWEET_ENABLE_ACTIONS` unset because BotMark should not publish, reply, like, DM, or follow. + +Use this route when the default `x_search` path is unavailable or when you want BotMark ingestion to share the same Hermes Tweet X/Twitter plugin setup as other Hermes workflows. + ## Optional cron proposal See `docs/cron-proposal.md`. Cron should be explicitly approved by the user before creation. diff --git a/SKILL.md b/SKILL.md index e9486d3..64ba7e3 100644 --- a/SKILL.md +++ b/SKILL.md @@ -50,6 +50,9 @@ Recommended local files: - `x_search` tool enabled and authenticated with xAI/SuperGrok/XAI credentials supported by your Hermes setup. - File tools enabled if you want Hermes to write notes/state. - Optional: an Obsidian vault or any local notes folder. +- Optional: Hermes Tweet installed with `XQUIK_API_KEY` for read-only public marker and parent-post lookup. + +If using Hermes Tweet, leave `HERMES_TWEET_ENABLE_ACTIONS` unset. BotMark is a read/search/save workflow and must not publish, reply, like, DM, or follow. ## Marker behavior @@ -78,6 +81,10 @@ from: #BotMark -filter:replies since:YYYY-MM-DD If date filtering hides recent posts, also try without `since:`. +## Optional Hermes Tweet lookup + +When Hermes Tweet is available, use its read-only tools as an alternate lookup path for public marker posts, parent posts, quoted posts, and cited X URLs. Preserve the same item schema and dedupe rules below. Treat Hermes Tweet as a lookup source only; do not enable action tools for this skill. + ## Item capture schema For every citation-backed BotMark result, capture: diff --git a/docs/configuration.md b/docs/configuration.md index 85ff772..0e6a9a6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -20,8 +20,11 @@ INCLUDE_QUOTE_POSTS=true SILENT_IF_NO_NEW=true SAVE_UNRESOLVED=true ENABLE_DAILY_SIGNAL_MINING=false +XQUIK_API_KEY= ``` +If `XQUIK_API_KEY` is set and Hermes Tweet is installed, BotMark may use Hermes Tweet's read-only tools for public marker and parent-post lookup. Keep `HERMES_TWEET_ENABLE_ACTIONS` unset for BotMark. + ## Route buckets Default stable buckets: