GitHub
Copied to clipboard!

Vibe CMS User Manual

Version: 1.0 Last Updated: November 2025 For: vibe-cms-sdk v0.2.1+

Welcome to Vibe CMS

Vibe CMS is a modern, headless content management system designed for AI-first workflows. This manual will guide you through setup, configuration, and daily usage of Vibe CMS with Claude Code via the Model Context Protocol (MCP).

📖 Table of Contents

Part I: Getting Started

  1. Chapter 1: MCP Server Installation

    • Prerequisites
    • Installation methods
    • Configuration
    • Verification
    • Troubleshooting

  2. Chapter 2: First Steps with Vibe CMS (Coming Soon)

    • Understanding collections
    • Creating your first content
    • Working with translations
    • Managing files

  3. Chapter 3: Project Setup (Coming Soon)

    • Integrating vibe-cms-sdk
    • Environment configuration
    • API authentication
    • Basic queries

Part II: Core Concepts

  1. Chapter 4: Content Architecture (Coming Soon)

    • Collections and schemas
    • Content items and translations
    • Locales and internationalization
    • Draft vs. published content

  2. Chapter 5: File Management (Coming Soon)

    • Folder structure
    • Upload methods
    • Metadata and SEO
    • Image optimization

  3. Chapter 6: Fields and Data Types (Coming Soon)

    • Field types overview
    • Interface options
    • Validation and constraints
    • Custom field patterns

Part III: Advanced Usage

  1. Chapter 7: Working with Claude Code (Coming Soon)

    • MCP tools reference
    • Common workflows
    • Automation patterns
    • Best practices

  2. Chapter 8: Content Operations (Coming Soon)

    • Bulk operations
    • Content migration
    • Version control
    • Rollback strategies

  3. Chapter 9: Multi-language Content (Coming Soon)

    • Locale management
    • Translation workflows
    • Language fallbacks
    • RTL support

Part IV: Integration & Development

  1. Chapter 10: SDK Integration (Coming Soon)

    • JavaScript/TypeScript usage
    • React hooks and components
    • API reference
    • Error handling

  2. Chapter 11: Security & Permissions (Coming Soon)

    • API keys and tokens
    • Project-level security
    • Content access control
    • Best practices

  3. Chapter 12: Performance Optimization (Coming Soon)

    • Caching strategies
    • Query optimization
    • File delivery
    • Monitoring

Part V: Reference

  • Appendix A: MCP Tools Reference (Coming Soon)
  • Appendix B: Error Codes & Solutions (Coming Soon)
  • Appendix C: Migration Guides (Coming Soon)
  • Appendix D: API Endpoint Reference (Coming Soon)
  • Appendix E: Glossary (Coming Soon)

🚀 Quick Start Path

New to Vibe CMS? Follow this learning path:

  1. Day 1: Read Chapter 1 and set up the MCP server
  2. Day 2: Complete Chapter 2 to understand core concepts
  3. Day 3: Follow Chapter 3 to integrate into your project
  4. Week 2: Explore Chapters 4-6 based on your needs
  5. Ongoing: Use Part V as a reference for daily work

💡 How to Use This Manual

For Beginners

  • Start with Part I and work sequentially
  • Complete hands-on exercises in each chapter
  • Use the troubleshooting sections when stuck
  • Refer to the glossary for unfamiliar terms

For Experienced Users

  • Jump to specific chapters as needed
  • Use Part V as a quick reference
  • Focus on Part III for advanced patterns
  • Check Part IV for integration details

For Developers

  • Review Part I for setup
  • Deep dive into Part IV for technical details
  • Use Appendix A for MCP tool specifications
  • Reference Appendix D for API documentation

🆘 Getting Help

Documentation Resources

Support Channels

  • GitHub Issues: Report bugs and feature requests
  • Community Forum: Ask questions and share solutions
  • Email Support: For enterprise customers
  • Documentation Feedback: help@vibecms.com

📋 Document Conventions

Throughout this manual, you'll see these indicators:

✅ REQUIRED - Must be completed for proper functionality ⚡ RECOMMENDED - Strongly suggested for best results 💡 TIP - Helpful information or shortcut ⚠️ WARNING - Important information to prevent issues 🔒 SECURITY - Security-related best practice 🐛 TROUBLESHOOTING - Common problems and solutions

Code Examples

# Terminal commands appear in bash format
npm install vibe-cms-sdk

// Configuration files use JSON format
{
  "projectId": "your-project-id"
}

// Code examples use TypeScript
import { VibeCMS } from 'vibe-cms-sdk';

Visual Indicators

  • inline code - Commands, file names, or code snippets
  • Bold - Important terms or emphasis
  • Italic - Notes or supplementary information

  • Quote blocks - User quotes or testimonials

📝 About This Manual

Versioning

This manual follows semantic versioning (MAJOR.MINOR.PATCH):

  • Major (1.x.x) - Significant restructuring or new parts
  • Minor (x.1.x) - New chapters or major updates
  • Patch (x.x.1) - Corrections, clarifications, or small additions

Contributing

Found an error or want to improve this documentation? We welcome contributions:

  1. Fork the documentation repository
  2. Make your changes with clear commit messages
  3. Submit a pull request with a description
  4. Wait for review and approval

Changelog

  • v1.0.0 (Nov 2025) - Initial release with Chapter 1

🎯 Learning Objectives

By the end of this manual, you will be able to:

  • ✅ Install and configure the Vibe CMS MCP server
  • ✅ Create and manage content collections
  • ✅ Work with multi-language content effectively
  • ✅ Upload and organize media files
  • ✅ Integrate Vibe CMS into web applications
  • ✅ Use Claude Code for content operations
  • ✅ Troubleshoot common issues independently
  • ✅ Implement security best practices
  • ✅ Optimize performance for production use

🙏 Acknowledgments

This manual was created with feedback from:

  • Early adopters and beta testers
  • The Claude Code community
  • Vibe CMS development team
  • Technical documentation specialists
  • Pascal Dufour & Anton Steininger

Ready to get started? → Continue to Chapter 1: MCP Server Installation

Vibe CMS - Content management for the AI era