CDS User Guide#
After successfully deploying CDS, you can interact with the system through three primary methods. Most users will use a combination of these methods depending on their workflow.
Web User Interface (UI): An interactive visual interface for search and exploration
Command Line Interface (CLI): A simplified interface for common tasks including collection management, ingestion, and search; built on top of the REST API.
REST API: Direct programmatic access via HTTP/curl for custom integrations.
Getting Started#
These user guides are the recommended next steps after a successful deployment and serve as starting points for learning to use CDS. For full documentation on each component (Web UI, CLI, REST API), complete reference guides are provided below.
Choose the interface that best fits your workflow.
Web User Interface#
Interactive visual interface for search and exploration.
Command Line Interface#
Simplified command-line tools for collection management, ingestion, and search operations.
REST API#
Direct programmatic access via HTTP for custom integrations. Interactive API docs are available at http://localhost:8888/v1/docs.