search
Algolia CLI for CI
Use the Algolia CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
10 functions 5 read 5 write API key auth
Algolia CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The Algolia CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Algolia CLI for CI
kosmokrator integrations:configure algolia --set app_id="$ALGOLIA_APP_ID" --set api_key="$ALGOLIA_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call algolia.algolia_search '{"indexName":"example_indexName","query":"example_query","filters":"example_filters","hitsPerPage":1,"page":1,"attributesToRetrieve":"example_attributesToRetrieve","facets":"example_facets","facetFilters":"example_facetFilters"}' --json Discovery Before Execution
Agents and scripts can inspect Algolia docs and schemas before choosing a function.
kosmo integrations:docs algolia --json
kosmo integrations:docs algolia.algolia_search --json
kosmo integrations:schema algolia.algolia_search --json
kosmo integrations:search "Algolia" --json
kosmo integrations:list --json Useful Algolia CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
algolia.algolia_search | Read | indexName, query, filters, hitsPerPage, page, attributesToRetrieve, facets, facetFilters, numericFilters | Search an Algolia index. Supports full-text search with filters, faceting, and pagination. Use this to find records matching a query string or filter criteria. |
algolia.algolia_get_object | Read | indexName, objectID, attributesToRetrieve | Retrieve a single record from an Algolia index by its objectID. Returns all attributes of the object. |
algolia.algolia_save_object | Write | indexName, objectID, body | Create or replace a record in an Algolia index. The object is identified by its objectID. If a record with this objectID exists, it will be fully replaced. |
algolia.algolia_delete_object | Write | indexName, objectID | Delete a record from an Algolia index by its objectID. This action is irreversible. |
algolia.algolia_partial_update | Write | indexName, objectID, attributes | Update specific attributes of a record without replacing the entire object. Only the specified attributes will be changed; all other attributes remain unchanged. |
algolia.algolia_list_indices | Read | page, hitsPerPage | List all indices in the Algolia application. Returns index names, entry counts, and sizes information. |
algolia.algolia_get_settings | Read | indexName | Get the configuration settings of an Algolia index, including searchable attributes, ranking, facets, and more. |
algolia.algolia_clear_index | Write | indexName | Remove all records from an Algolia index. The index itself is preserved with its settings. This action is irreversible. |
algolia.algolia_batch | Write | indexName, requests | Perform multiple write operations (addObject, updateObject, partialUpdateObject, deleteObject) in a single batch request for better performance. |
algolia.algolia_get_current_user | Read | none | List API keys for the Algolia application. Use this to verify that authentication is working and to see which API keys exist. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.