Compound Collections
Create, search, import, and export molecular compound libraries from the command line.
Difficulty
The ivybloom CLI is the scriptable surface for the platform, and compound collections are how you create, search, import, and export molecular libraries from the command line. Reach for them when a scripted pipeline needs a managed set of molecules — a screening library to feed batch ADMET or docking, a hit list, a lead series, or a reference set. They give your automation a durable, reusable input surface; for the full command surface, see the CLI overview.
Compound Collections (since v0.8.10)
Create, search, import, and export molecular compound libraries from the command line.
Overview
Compound collections are sets of molecules stored together for analysis. Common use cases:
- Screening libraries — Import compound sets for batch ADMET or docking
- Hit lists — Collect compounds that pass screening criteria
- Lead series — Track optimized compounds through the pipeline
- Reference sets — Maintain known drug or fragment libraries
Commands marked with MCP are available via ivybloom mcp serve for AI agent integration. They do not have dedicated CLI subcommands.
Creating Collections
NAMEstringrequiredCollection name (first positional argument).
--descriptionstringOptional description of the collection.
--projectstringProject ID to associate the collection with.
Importing Compounds
Submit a file to import compounds from CSV, SDF, or SMILES formats:
Supported Formats
| Format | Extension | Description |
|---|---|---|
| CSV | .csv | Comma-separated with SMILES column (required) |
| SDF | .sdf | Structure-Data File (3D coordinates) |
| SMILES | .smi | One SMILES string per line |
Import Parameters
COLLECTION_IDstringrequiredCollection to import into (first positional argument).
FILEstringrequiredFile to import (second positional argument).
--skip-duplicatesbooldefault: falseCheck against existing compounds in the collection (not yet implemented; reserved for future use).
--tagstringAttach a label to imported compounds for later filtering (not yet implemented; reserved for future use).
--waitbooldefault: trueWait for import to complete. Set to false to submit and return an import ID for polling.
Status
The import endpoint accepts requests and returns status: "pending" with a note, but compounds are not imported yet. The feature is under development. Contact support for ETA.
Searching
Search compounds using four search types: substructure, similarity, text and property. The query goes in a flag, not a positional argument.
Substructure Search
Find all molecules containing a specific substructure (e.g., benzene ring):
Similarity Search
Find molecules similar to a query (Tanimoto coefficient):
Text Search
Search by compound name or metadata:
Property Filter
Filter by computed properties:
COLLECTION_IDstringrequiredCollection to search in (first positional argument).
--typestringdefault: textSearch type: substructure, similarity, text, or property.
--smartsstringQuery SMARTS for substructure search.
--smilesstringQuery SMILES for similarity search.
--querystringText query for text search.
--filterstringProperty filter such as mw<500. Repeat the flag to combine filters.
--thresholdfloatdefault: 0.7Similarity threshold (0-1). Only applies to similarity search.
--limitintdefault: 100Maximum number of results to return.
Output Examples
Exporting
Export a collection to a file:
COLLECTION_IDstringrequiredCollection to export (first positional argument).
--formatstringdefault: jsonOutput format: json, sdf, smiles, or csv.
--outputstringOutput file path (-o shorthand). Defaults to stdout.
Listing and Deleting
List Collections
--projectstringFilter by project ID.
--limitintdefault: 100Maximum collections to return.
--jsonboolOutput as JSON.
Delete a Collection
Deleting a collection permanently removes all compounds in it. This cannot be undone.
Workflow Integration
Pipe to Batch ADMET Screening
Export a collection, then screen through ADMET:
Docking Library Preparation
Combine with protein preparation for a complete docking workflow:
Read next
- Batch Processing — Screen compound libraries at scale
- Protein Preparation — Prepare targets for docking
- Job Management — Monitor individual analysis jobs
- Recipes — End-to-end drug discovery workflows
Was this page helpful?
ivybloom CLI Commands — Complete Reference
Reference for every ivybloom CLI command and its MCP equivalent, organized by category with flags and parameter formats.
CLI Configuration
Set api_url, timeout, format and debug per profile, override them with IVYBLOOM_* environment variables or flags, and register a BYOK provider key.