--- name: pp-algolia description: "Every Algolia feature, plus offline search and a local database no other Algolia tool has. Trigger phrases: `search my Algolia index`, `list my Algolia indices`, `check Algolia API keys`, `find stale Algolia rules`, `compare Algolia index settings`." author: "Som Samantray" license: "Apache-2.0" argument-hint: " [args] | install cli|mcp" allowed-tools: "Read Bash" metadata: openclaw: requires: bins: - algolia-pp-cli install: - kind: go bins: [algolia-pp-cli] module: github.com/mvanhorn/printing-press-library/library/developer-tools/algolia/cmd/algolia-pp-cli --- # Algolia — Printing Press CLI ## Prerequisites: Install the CLI This skill drives the `algolia-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first: 1. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows: ```bash npx -y @mvanhorn/printing-press-library install algolia --cli-only ``` 2. Verify: `algolia-pp-cli --version` 3. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill. If the `npx` install fails before this CLI has a public-library category, install Node or use the category-specific Go fallback after publish. If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds. The Algolia CLI manages indices, records, search, rules, synonyms, API keys, and settings from the terminal — with a local SQLite mirror, cross-index search, settings diffing, and relevance regression checks that the official CLI cannot offer. ## When to Use This CLI Use this CLI when you manage Algolia indices, records, rules, synonyms, or API keys from the terminal, or when you need offline access to your Algolia data for scripts, CI, and agent workflows. ## Anti-triggers Do not use this CLI for: - Do not use this CLI for Algolia Analytics or Recommend product APIs — those are separate products with their own hosts. - Do not use this CLI as a full dashboard replacement for complex merchandising visual workflows. ## Unique Capabilities These capabilities aren't available in any other tool for this API. ### Local state that compounds - **`find`** — Search across every synced index in one shot, with each hit labeled by its source index. _Use this when you need to know which of your indices contains a record, without issuing N API calls._ ```bash algolia-pp-cli find --query "dune" --limit 20 ``` - **`settings diff`** — Field-level comparison of settings between two indices (or a settings file vs an index). _Use this to verify prod/staging parity before a release instead of exporting and eyeballing JSON._ ```bash algolia-pp-cli settings diff algolia_movie_sample_dataset staging_movies ``` - **`rules stale`** — Find rules that reference attributes missing from the index's searchable attributes or that can never match. _Use this to find dead-weight relevance rules before they silently corrupt search results._ ```bash algolia-pp-cli rules stale --index algolia_movie_sample_dataset ``` - **`apikeys report`** — Audit all API keys: write-capable, unrestricted, and expired keys grouped by ACL, with last-use from synced logs. _Use this for key rotation audits to catch write-capable keys that have gone unused for months._ ```bash algolia-pp-cli apikeys report ``` - **`objects gaps`** — List records missing attributes required by the index's searchable settings — records search can never return. _Use this after catalog imports to find records that are silently unreachable by search._ ```bash algolia-pp-cli objects gaps --index algolia_movie_sample_dataset ``` - **`objects diff`** — Compare records of two indices (added/removed/changed by objectID) to verify prod/staging parity. _Use this to reconcile dev and prod copies after a copy/move operation instead of exporting and diffing files._ ```bash algolia-pp-cli objects diff algolia_movie_sample_dataset staging_movies ``` ### Agent-native plumbing - **`search check`** — Assert that a query returns expected objectIDs, with a typed exit code for CI pipelines. _Use this after every rule or synonym change to catch relevance regressions before they reach users._ ```bash algolia-pp-cli search check --index algolia_movie_sample_dataset --query "dune" --expect media-sample-data-438631 ``` - **`logs errors`** — Aggregate synced log entries by error code and link failed tasks for a digest of what went wrong. _Use this for weekly error triage to see error spikes and affected indices at a glance._ ```bash algolia-pp-cli logs errors --since 24h ``` ## Command Reference **clusters** — Multi-cluster operations. Multi-cluster operations are **deprecated**. If you have issues with your Algolia infrastructure due to large volumes of data, contact the Algolia support team. - `algolia-pp-cli clusters assign-user-id` — Assigns or moves a user ID to a cluster. - `algolia-pp-cli clusters batch-assign-user-ids` — Assigns multiple user IDs to a cluster. **You can't move users with this operation**. - `algolia-pp-cli clusters get-top-user-ids` — Get the IDs of the 10 users with the highest number of records per cluster. - `algolia-pp-cli clusters get-user-id` — Returns the user ID data stored in the mapping. - `algolia-pp-cli clusters has-pending-mappings` — To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to - `algolia-pp-cli clusters list` — Lists the available clusters in a multi-cluster setup. - `algolia-pp-cli clusters list-user-ids` — Lists the userIDs assigned to a multi-cluster application. - `algolia-pp-cli clusters remove-user-id` — Deletes a user ID and its associated data from the clusters. - `algolia-pp-cli clusters search-user-ids` — Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. **dictionaries** — Manage your dictionaries. Customize language-specific settings, such as stop words, plurals, or word segmentation. Dictionaries are application-wide. - `algolia-pp-cli dictionaries get-dictionary-languages` — Lists supported languages with their supported dictionary types and number of custom entries. - `algolia-pp-cli dictionaries get-dictionary-settings` — Retrieves the languages for which standard dictionary entries are turned off. - `algolia-pp-cli dictionaries set-dictionary-settings` — Turns standard stop word dictionary entries on or off for a given language. **indexes** — Manage indexes - `algolia-pp-cli indexes add-or-update-object` — If a record with the specified object ID exists, the existing record is replaced. - `algolia-pp-cli indexes delete-index` — Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - `algolia-pp-cli indexes delete-object` — Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia. - `algolia-pp-cli indexes get-object` — Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www. - `algolia-pp-cli indexes get-objects` — Retrieves one or more records, potentially from different indices. - `algolia-pp-cli indexes list-indices` — Lists all indices in the current Algolia application. - `algolia-pp-cli indexes multiple-batch` — Adds, updates, or deletes records in multiple indices with a single API request. - `algolia-pp-cli indexes save-object` — Adds a record to an index or replaces it. - `algolia-pp-cli indexes search` — Runs multiple search queries against one or more indices in a single API request. **keys** — Manage keys - `algolia-pp-cli keys add-api` — Creates a new API key with specific permissions and restrictions. - `algolia-pp-cli keys delete-api` — Deletes the API key. - `algolia-pp-cli keys get-api` — Gets the permissions and restrictions of an API key. - `algolia-pp-cli keys list-api` — Lists all API keys associated with your Algolia application, including their permissions and restrictions. - `algolia-pp-cli keys update-api` — Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value. **logs** — Manage logs - `algolia-pp-cli logs` — The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia. **security** — Manage security - `algolia-pp-cli security append-source` — Adds a source to the list of allowed sources. - `algolia-pp-cli security delete-source` — Deletes a source from the list of allowed sources. - `algolia-pp-cli security get-sources` — Retrieves all allowed IP addresses with access to your application. - `algolia-pp-cli security replace-sources` — Replaces the list of allowed sources. **task** — Manage task - `algolia-pp-cli task ` — Checks the status of a given application task. ### Finding the right command When you know what you want to do but not which command does it, ask the CLI directly: ```bash algolia-pp-cli which "" ``` `which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query. ## Recipes ### Verify a relevance change ```bash algolia-pp-cli search check --index algolia_movie_sample_dataset --query "dune" --expect media-sample-data-438631 ``` Assert that a query still returns an expected hit — run in CI after every rule or synonym change. ### Find dead rules ```bash algolia-pp-cli rules stale --index algolia_movie_sample_dataset ``` Surface rules that reference removed attributes or can never match. ### Compare prod and staging settings ```bash algolia-pp-cli settings diff algolia_movie_sample_dataset staging_movies ``` See exactly which settings differ between two indices before a release. ### Cross-index lookup ```bash algolia-pp-cli find --query "dune" --select index,objectID,title --limit 10 ``` Find which synced index contains a record and narrow the output with --select. ### Audit API keys ```bash algolia-pp-cli apikeys report ``` Get a permission matrix of write-capable, unrestricted, and expired keys. ## Auth Setup Algolia uses two credentials: your Application ID (ALGOLIA_APPLICATION_ID) and an API key (ALGOLIA_API_KEY), sent as x-algolia-application-id and x-algolia-api-key headers. Find both in the Algolia dashboard under Settings > API Keys. Export them before running the CLI. Run `algolia-pp-cli doctor` to verify setup. ## Agent Mode Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`. - **Pipeable** — JSON on stdout, errors on stderr - **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs: ```bash algolia-pp-cli clusters list --agent ``` - **Previewable** — `--dry-run` shows the request without sending - **Offline-friendly** — sync/search commands can use the local SQLite store when available - **Non-interactive** — never prompts, every input is a flag - **Explicit retries** — use `--idempotent` only when an already-existing create should count as success, and use `--ignore-missing` only when a missing delete target should count as success ### Response envelope Commands that read from the local store or the API wrap output in a provenance envelope: ```json { "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."}, "results": } ``` Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr only when stdout is a terminal AND no machine-format flag (`--json`, `--csv`, `--compact`, `--quiet`, `--plain`, `--select`) is set — piped/agent consumers and explicit-format runs get pure JSON on stdout. ## Paths and state Agents should treat the CLI's path resolver as part of the runtime contract: - Use `--home ` for one invocation, or set `ALGOLIA_HOME=` to relocate all four path kinds under one root. - Use per-kind env vars only when a specific kind must diverge: `ALGOLIA_CONFIG_DIR`, `ALGOLIA_DATA_DIR`, `ALGOLIA_STATE_DIR`, `ALGOLIA_CACHE_DIR`. - Resolution order is per-kind env var, `--home`, `ALGOLIA_HOME`, XDG (`XDG_CONFIG_HOME`, `XDG_DATA_HOME`, `XDG_STATE_HOME`, `XDG_CACHE_HOME`), then platform defaults. - `config` contains settings like `config.toml` and profiles. `data` contains `credentials.toml`, `data.db`, cookies, and auth sidecars. `state` contains persisted queries, jobs, and `teach.log`. `cache` contains regenerable HTTP/cache files. - Stored secrets live in `credentials.toml` under the data dir. Existing legacy `config.toml` secrets are read for compatibility and leave `config.toml` on the first auth write. - Run `algolia-pp-cli doctor --fail-on warn` to surface path and credential-location warnings. `agent-context` exposes a schema v4 `paths` block for agents that need the resolved dirs. - For MCP, pass relocation through the MCP host config. The MCP binary does not inherit CLI flags: ```json { "mcpServers": { "algolia": { "command": "algolia-pp-mcp", "env": { "ALGOLIA_HOME": "/srv/algolia" } } } } ``` Fleet precedence: an inherited per-kind env var overrides an explicit `--home` for that kind. Use `ALGOLIA_HOME` or per-kind vars as durable fleet levers, and use `--home` only for a single invocation. Relocation is not reversible by unsetting env vars; move files manually before clearing `ALGOLIA_HOME`, or `doctor` will not find credentials left under the former root. ## Automatic learning This CLI ships a self-capturing learning loop. The CLI does its own bookkeeping: every invocation is journaled locally, a failed flag followed by a corrected retry auto-derives a `flag_alias` candidate, and a `teach` on a query family without a playbook auto-synthesizes a `playbook_candidate` from the session's journal. Your job is judgment only: `recall` first, act on surfaced candidates, `teach` the final answer, `playbook amend` when you observe a correction. You never record failures by hand. ### Step 1: `recall` before any discovery Before list/search/drill commands on a new user question, run: ```bash algolia-pp-cli recall "" --agent ``` The response envelope: ```json { "query": "...", "normalized": "", "query_entities": ["..."], "found": true | false, "match_score": 0.0, "results": [ { "resource_id": "...", "resource_type": "...", "venue": "...", "confidence": 2, "entity_match": "exact|partial|unknown", "source": "taught|preseed|pattern", "warnings": ["..."] } ], "mismatches": [ /* only when --debug-mismatches */ ], "warnings": [ /* top-level */ ], "candidates": [ { "id": 12, "class": "flag_alias | playbook_candidate", "summary": "...", "sightings": 3, "last_seen": "...", "rationale": "...", "next_action": ["", "algolia-pp-cli learnings confirm 12"] } ], "playbook": { "query_family": "...", "playbook": { "steps": [ { "cmd": "", "purpose": "..." } ], "entity_slots": ["$ENTITY"], "expected_tool_calls": 3 }, "slots_resolved": { "$ENTITY": { "token": "", "canonical": "" } }, "notes": "" }, "notes": "" } ``` Empty-store short-circuit: if the store has no learnings, playbooks, or candidates yet (recall finds nothing and `learnings list` and `learnings candidates` are both empty), skip recall for the rest of this session instead of taxing every query; resume recall-first once something has been taught. ### Step 2: decision tree Read `candidates`, `playbook`, `notes`, `results[0]`, and warnings in that order: ``` if Candidates present (warnings include "candidates_present"): -> candidates are try-then-confirm, never facts. Follow each candidate's two-step next_action verbatim: run the trial command first, then run `learnings confirm ` only after the trial verified the behavior. Reject a wrong candidate with `learnings reject `. -> NEVER re-teach something recall surfaced as a candidate; confirm or reject that candidate instead of teaching a duplicate. -> candidates ride alongside playbooks and resource hits, not instead of them; continue with the branches below after acting on them. if Playbook present: -> READ Playbook.notes verbatim FIRST (workarounds + gotchas the CLI surface doesn't expose) -> replay Playbook.steps in order, substituting Playbook.slots_resolved entries for the entity slot tokens. If a step's slot is unresolved, fall back to discovery for that step only. -> the Playbook's expected_tool_calls is a budget; if you find yourself running materially more, record the divergence via `algolia-pp-cli playbook amend` at end-of-session. elif Notes present (no Playbook): -> read Notes verbatim before any discovery step; they carry known gotchas for this query family even when no structured choreography exists yet. elif Found AND Results[0].EntityMatch == "exact" AND Results[0].Confidence >= 2: -> skip discovery; fetch live data for Results[*].ResourceID in parallel elif Found AND Results[0].EntityMatch == "partial": -> candidate hint, NOT a hit; read the resource title to validate before trusting elif (any row in Mismatches[] when --debug-mismatches was passed): -> treat as cold start; the stored learning is for a different entity (different canonical resolved from query_entities) else: // Found == false, no playbook, no notes -> cold start; run discovery normally; teach the answer afterward (Step 4). If the family has no playbook yet, that teach auto-synthesizes a playbook candidate from this session's journal - you do not need to record one by hand. ``` Playbook and Notes are orthogonal to the per-resource path. A recall response can carry both a Playbook AND a `Results[]` hit - use both: the Playbook tells you which choreography to run; the resource hits short-circuit specific steps. Default to skipping `mismatches`; pass `--debug-mismatches` only when investigating cold-start surprises. Candidate judgment details: `learnings confirm ` prints the candidate's full payload before materializing it - check that the printed payload matches the behavior you verified. `learnings reject ` tombstones the derivation signature so the same candidate does not resurface. The envelope carries only the few candidates worth acting on now; `algolia-pp-cli learnings candidates` lists the full open set. Graceful degradation: if `learnings confirm` is an unknown command, you are driving an older binary - ignore the candidates guidance and follow the rest of the protocol. ### Step 3: always read `warnings` - `low_confidence`: row exists at `confidence<2`. Treat as a hint, not a skip-discovery hit. - `resource_not_in_store`: the local store doesn't have the resource the learning points at. The match validator couldn't classify entities — direct-fetch and re-evaluate. - `cross_alias_match` (per-result): the row was taught under a different alias and matched the live query's canonical via `entity_lookups` (e.g., a "USA" teach satisfying a "United States" recall). Trust the resource_id. - `similar_shape_differe