Use the CLI¶
The iscc-search CLI manages indexes, adds assets, searches for similar content, and starts the REST API
server. All data commands operate on the active index unless you override it with --index.
Manage indexes¶
Register a local index:
Register a local index with a custom data path:
Register a remote index pointing to a running iscc-search server:
Register a remote index with an API key:
List all configured indexes:
Switch the active index:
Remove an index from configuration:
Remove an index and delete its local data:
Index HuggingFace datasets¶
The ISCC Foundation publishes ready-to-index datasets on the HuggingFace Hub. Browse them:
The listing defaults to the iscc organization. Switch to another namespace with --author, cap the
output with --limit, or emit JSON for scripting:
Index a dataset directly — parquet files are streamed from the Hub and cached under your HuggingFace cache directory:
When no index is registered yet, hub auto-creates a local one named after the dataset
(iscc/iscc-flickr30k → flickr30k). Override the target name or stop early while experimenting:
iscc-search hub iscc/iscc-book-covers --limit 10000
iscc-search hub iscc/iscc-flickr30k --index production
iscc-search hub iscc/iscc-flickr30k --split train --batch-size 1000
Original row fields (title, caption, ISBN, image URLs, …) are preserved as opaque metadata on each asset; binary columns such as image thumbnails are skipped.
Add assets¶
Add assets from a directory of JSON files:
The command looks for *.iscc.json files first, then falls back to *.json. Each file must contain at least
an iscc_code or iscc field.
Add assets with a glob pattern:
Add a single file:
Control batch size and truncate simprints:
Target a specific index instead of the active one:
Retrieve assets¶
Fetch full asset details by ISCC-ID:
Target a specific index:
Search for similar assets¶
Search by ISCC-CODE:
Limit the number of results:
Search a specific index:
Start the server¶
Start in production mode:
Start in development mode with auto-reload:
Use a custom host and port: