[{"data":1,"prerenderedAt":480},["ShallowReactive",2],{"content-query-JDxdyuLTM9":3},{"_path":4,"_dir":5,"_draft":6,"_partial":6,"_locale":7,"title":8,"description":9,"sidebar_position":10,"body":11,"_type":474,"_id":475,"_source":476,"_file":477,"_stem":478,"_extension":479},"/docs/getting-started","docs",false,"","Getting Started","This guide walks you through setting up CredVault and creating your first project. By the end, you'll have a working database cluster and be ready to build your application.",2,{"type":12,"children":13,"toc":460},"root",[14,23,28,35,57,62,68,73,83,93,103,113,119,124,143,153,163,173,185,191,196,203,215,221,226,236,246,256,266,279,285,290,295,301,325,330,340,345,355,365,371,376,381,386,392,397,407,417,427,437,447],{"type":15,"tag":16,"props":17,"children":19},"element","h1",{"id":18},"getting-started-with-credvault",[20],{"type":21,"value":22},"text","Getting Started with CredVault",{"type":15,"tag":24,"props":25,"children":26},"p",{},[27],{"type":21,"value":9},{"type":15,"tag":29,"props":30,"children":32},"h2",{"id":31},"creating-your-account",[33],{"type":21,"value":34},"Creating Your Account",{"type":15,"tag":24,"props":36,"children":37},{},[38,40,47,49,55],{"type":21,"value":39},"Your CredVault journey begins with creating an account. Visit the ",{"type":15,"tag":41,"props":42,"children":44},"a",{"href":43},"/signup",[45],{"type":21,"value":46},"Registration Page",{"type":21,"value":48}," and click ",{"type":15,"tag":50,"props":51,"children":52},"strong",{},[53],{"type":21,"value":54},"Get Started",{"type":21,"value":56},". You can register using your email address or sign in with Google or GitHub for faster onboarding.",{"type":15,"tag":24,"props":58,"children":59},{},[60],{"type":21,"value":61},"After confirming your email, you'll land in the CredVault dashboard — your command center for managing all platform resources. Take a moment to explore the interface. The left sidebar provides navigation to different sections, while the main area displays your resources and activity.",{"type":15,"tag":29,"props":63,"children":65},{"id":64},"understanding-your-workspace",[66],{"type":21,"value":67},"Understanding Your Workspace",{"type":15,"tag":24,"props":69,"children":70},{},[71],{"type":21,"value":72},"Every CredVault account operates within a workspace, which serves as the top-level container for all your resources. Your workspace includes:",{"type":15,"tag":24,"props":74,"children":75},{},[76,81],{"type":15,"tag":50,"props":77,"children":78},{},[79],{"type":21,"value":80},"Database Clusters",{"type":21,"value":82}," — Managed database instances where your data lives. You can create multiple clusters for different environments (development, staging, production) or applications.",{"type":15,"tag":24,"props":84,"children":85},{},[86,91],{"type":15,"tag":50,"props":87,"children":88},{},[89],{"type":21,"value":90},"Team Members",{"type":21,"value":92}," — Colleagues you invite to collaborate on your projects. Each member can have different permissions based on their role.",{"type":15,"tag":24,"props":94,"children":95},{},[96,101],{"type":15,"tag":50,"props":97,"children":98},{},[99],{"type":21,"value":100},"API Keys",{"type":21,"value":102}," — Credentials for programmatic access to your resources. Create different keys for different applications or environments.",{"type":15,"tag":24,"props":104,"children":105},{},[106,111],{"type":15,"tag":50,"props":107,"children":108},{},[109],{"type":21,"value":110},"Billing and Usage",{"type":21,"value":112}," — View your resource consumption and manage payment methods.",{"type":15,"tag":29,"props":114,"children":116},{"id":115},"creating-your-first-cluster",[117],{"type":21,"value":118},"Creating Your First Cluster",{"type":15,"tag":24,"props":120,"children":121},{},[122],{"type":21,"value":123},"A cluster is a managed database instance where your collections and documents reside. To create one:",{"type":15,"tag":24,"props":125,"children":126},{},[127,129,134,136,141],{"type":21,"value":128},"Navigate to ",{"type":15,"tag":50,"props":130,"children":131},{},[132],{"type":21,"value":133},"Clusters",{"type":21,"value":135}," in the sidebar and click ",{"type":15,"tag":50,"props":137,"children":138},{},[139],{"type":21,"value":140},"Create Cluster",{"type":21,"value":142},". You'll choose a few options:",{"type":15,"tag":24,"props":144,"children":145},{},[146,151],{"type":15,"tag":50,"props":147,"children":148},{},[149],{"type":21,"value":150},"Cluster Name",{"type":21,"value":152}," — Pick something descriptive like \"production-main\" or \"dev-testing\". This helps you identify clusters quickly as your infrastructure grows.",{"type":15,"tag":24,"props":154,"children":155},{},[156,161],{"type":15,"tag":50,"props":157,"children":158},{},[159],{"type":21,"value":160},"Region",{"type":21,"value":162}," — Select the geographic location closest to your users for optimal performance. Data residency requirements may also influence this choice.",{"type":15,"tag":24,"props":164,"children":165},{},[166,171],{"type":15,"tag":50,"props":167,"children":168},{},[169],{"type":21,"value":170},"Tier",{"type":21,"value":172}," — Choose the appropriate size for your workload. Start with the free tier for development and testing. You can upgrade anytime as your needs grow.",{"type":15,"tag":24,"props":174,"children":175},{},[176,178,183],{"type":21,"value":177},"Click ",{"type":15,"tag":50,"props":179,"children":180},{},[181],{"type":21,"value":182},"Create",{"type":21,"value":184}," and wait a moment while CredVault provisions your cluster. Once ready, you'll see the cluster appear in your list with a green status indicator.",{"type":15,"tag":29,"props":186,"children":188},{"id":187},"connecting-to-your-cluster",[189],{"type":21,"value":190},"Connecting to Your Cluster",{"type":15,"tag":24,"props":192,"children":193},{},[194],{"type":21,"value":195},"With your cluster running, you're ready to connect. CredVault supports multiple connection methods to fit your workflow.",{"type":15,"tag":197,"props":198,"children":200},"h3",{"id":199},"using-the-dashboard",[201],{"type":21,"value":202},"Using the Dashboard",{"type":15,"tag":24,"props":204,"children":205},{},[206,208,213],{"type":21,"value":207},"The dashboard provides a built-in data explorer for browsing and querying your data without writing any code. Navigate to your cluster, open the ",{"type":15,"tag":50,"props":209,"children":210},{},[211],{"type":21,"value":212},"Data Explorer",{"type":21,"value":214}," tab, and start working with your collections interactively.",{"type":15,"tag":197,"props":216,"children":218},{"id":217},"using-the-sdks",[219],{"type":21,"value":220},"Using the SDKs",{"type":15,"tag":24,"props":222,"children":223},{},[224],{"type":21,"value":225},"For application development, install the official SDK for your programming language. All SDKs are available through standard package managers:",{"type":15,"tag":24,"props":227,"children":228},{},[229,234],{"type":15,"tag":50,"props":230,"children":231},{},[232],{"type":21,"value":233},"Node.js developers",{"type":21,"value":235}," can install from npm. The SDK provides TypeScript support out of the box with full type definitions.",{"type":15,"tag":24,"props":237,"children":238},{},[239,244],{"type":15,"tag":50,"props":240,"children":241},{},[242],{"type":21,"value":243},"Python developers",{"type":21,"value":245}," can install from PyPI. The package works with any Python application or Jupyter notebook.",{"type":15,"tag":24,"props":247,"children":248},{},[249,254],{"type":15,"tag":50,"props":250,"children":251},{},[252],{"type":21,"value":253},"Java developers",{"type":21,"value":255}," can add the dependency through Maven or Gradle. The SDK is compatible with Spring Boot and other popular frameworks.",{"type":15,"tag":24,"props":257,"children":258},{},[259,264],{"type":15,"tag":50,"props":260,"children":261},{},[262],{"type":21,"value":263},"Go developers",{"type":21,"value":265}," can fetch the module using standard Go tooling. The client follows Go idioms with explicit error handling.",{"type":15,"tag":24,"props":267,"children":268},{},[269,271,277],{"type":21,"value":270},"Visit the ",{"type":15,"tag":41,"props":272,"children":274},{"href":273},"/docs/sdks",[275],{"type":21,"value":276},"SDKs section",{"type":21,"value":278}," for detailed installation instructions and examples for each language.",{"type":15,"tag":197,"props":280,"children":282},{"id":281},"using-the-cli",[283],{"type":21,"value":284},"Using the CLI",{"type":15,"tag":24,"props":286,"children":287},{},[288],{"type":21,"value":289},"The CredVault command-line interface is perfect for scripting, automation, and developers who prefer working in the terminal. Install it through your package manager or download the binary directly.",{"type":15,"tag":24,"props":291,"children":292},{},[293],{"type":21,"value":294},"The CLI supports all platform operations: managing clusters, querying data, deploying functions, and more. It's also useful for CI/CD pipelines and infrastructure-as-code workflows.",{"type":15,"tag":29,"props":296,"children":298},{"id":297},"your-first-api-key",[299],{"type":21,"value":300},"Your First API Key",{"type":15,"tag":24,"props":302,"children":303},{},[304,306,311,313,317,318,323],{"type":21,"value":305},"To connect your applications to CredVault, you'll need an API key. Navigate to ",{"type":15,"tag":50,"props":307,"children":308},{},[309],{"type":21,"value":310},"Settings",{"type":21,"value":312}," → ",{"type":15,"tag":50,"props":314,"children":315},{},[316],{"type":21,"value":100},{"type":21,"value":48},{"type":15,"tag":50,"props":319,"children":320},{},[321],{"type":21,"value":322},"Create Key",{"type":21,"value":324},".",{"type":15,"tag":24,"props":326,"children":327},{},[328],{"type":21,"value":329},"Give your key a descriptive name that indicates its purpose — for example, \"backend-development\" or \"ci-pipeline\". This helps you track which applications are using which credentials.",{"type":15,"tag":24,"props":331,"children":332},{},[333,338],{"type":15,"tag":50,"props":334,"children":335},{},[336],{"type":21,"value":337},"Important",{"type":21,"value":339},": The full API key is displayed only once. Copy it immediately and store it securely. If you lose it, you'll need to create a new key.",{"type":15,"tag":24,"props":341,"children":342},{},[343],{"type":21,"value":344},"API keys come in two types:",{"type":15,"tag":24,"props":346,"children":347},{},[348,353],{"type":15,"tag":50,"props":349,"children":350},{},[351],{"type":21,"value":352},"Live Keys",{"type":21,"value":354}," — For production use. These keys access real data and count toward your billing.",{"type":15,"tag":24,"props":356,"children":357},{},[358,363],{"type":15,"tag":50,"props":359,"children":360},{},[361],{"type":21,"value":362},"Test Keys",{"type":21,"value":364}," — For development and testing. These keys access a sandboxed environment with separate data.",{"type":15,"tag":29,"props":366,"children":368},{"id":367},"storing-your-data",[369],{"type":21,"value":370},"Storing Your Data",{"type":15,"tag":24,"props":372,"children":373},{},[374],{"type":21,"value":375},"With a cluster and API key ready, you can start storing data. CredVault uses a document model similar to MongoDB, with data organized into collections of JSON-like documents.",{"type":15,"tag":24,"props":377,"children":378},{},[379],{"type":21,"value":380},"Collections are created automatically when you first insert data — no schema definition required. This flexibility lets you iterate quickly during development. As your application matures, you can define schemas and validation rules for data integrity.",{"type":15,"tag":24,"props":382,"children":383},{},[384],{"type":21,"value":385},"Each document in a collection has a unique identifier. You can let CredVault generate IDs automatically or provide your own. Documents can contain nested objects, arrays, and various data types including dates, numbers, and binary data.",{"type":15,"tag":29,"props":387,"children":389},{"id":388},"whats-next",[390],{"type":21,"value":391},"What's Next?",{"type":15,"tag":24,"props":393,"children":394},{},[395],{"type":21,"value":396},"You've completed the essential setup. Here are suggested next steps:",{"type":15,"tag":24,"props":398,"children":399},{},[400,405],{"type":15,"tag":50,"props":401,"children":402},{},[403],{"type":21,"value":404},"Explore the Data Explorer",{"type":21,"value":406}," — Familiarize yourself with querying and managing data through the dashboard.",{"type":15,"tag":24,"props":408,"children":409},{},[410,415],{"type":15,"tag":50,"props":411,"children":412},{},[413],{"type":21,"value":414},"Install an SDK",{"type":21,"value":416}," — Set up your development environment with the SDK for your programming language.",{"type":15,"tag":24,"props":418,"children":419},{},[420,425],{"type":15,"tag":50,"props":421,"children":422},{},[423],{"type":21,"value":424},"Try the Intelligence Engine",{"type":21,"value":426}," — If you're working with data analytics or machine learning, explore CIE's capabilities.",{"type":15,"tag":24,"props":428,"children":429},{},[430,435],{"type":15,"tag":50,"props":431,"children":432},{},[433],{"type":21,"value":434},"Invite Your Team",{"type":21,"value":436}," — Bring colleagues into your workspace to collaborate on projects.",{"type":15,"tag":24,"props":438,"children":439},{},[440,445],{"type":15,"tag":50,"props":441,"children":442},{},[443],{"type":21,"value":444},"Set Up Automation",{"type":21,"value":446}," — Create webhooks or triggers to automate workflows based on data changes.",{"type":15,"tag":24,"props":448,"children":449},{},[450,452,458],{"type":21,"value":451},"Continue to the ",{"type":15,"tag":41,"props":453,"children":455},{"href":454},"/docs/concepts",[456],{"type":21,"value":457},"Core Concepts",{"type":21,"value":459}," section to deepen your understanding of how CredVault works.",{"title":7,"searchDepth":10,"depth":10,"links":461},[462,463,464,465,471,472,473],{"id":31,"depth":10,"text":34},{"id":64,"depth":10,"text":67},{"id":115,"depth":10,"text":118},{"id":187,"depth":10,"text":190,"children":466},[467,469,470],{"id":199,"depth":468,"text":202},3,{"id":217,"depth":468,"text":220},{"id":281,"depth":468,"text":284},{"id":297,"depth":10,"text":300},{"id":367,"depth":10,"text":370},{"id":388,"depth":10,"text":391},"markdown","content:docs:getting-started.md","content","docs/getting-started.md","docs/getting-started","md",1777847380892]