Yorkie

If you want to update this page or add new content, please submit a pull request to the Homepage.

Tools & APIs

This section covers the developer tools and APIs for managing, debugging, and integrating with Yorkie beyond the client SDKs.

Topics

  • Devtools: Browser extension for inspecting and debugging Yorkie documents, presence, and events in real time
  • CLI: Command-line interface for managing projects, documents, and server configuration
  • Admin API: REST API for programmatic document and project management from server-side applications
  • MCP: Model Context Protocol server for integrating Yorkie with AI assistants and LLM-based tools

Prerequisites

Before exploring these topics, ensure you have:

  1. Completed the Getting Started guide
  2. Understood basic concepts like Client, Document, and Channel