[{"data":1,"prerenderedAt":776},["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":770,"_id":771,"_source":772,"_file":773,"_stem":774,"_extension":775},"\u002Fdocs\u002Fgetting-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":750},"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,403,492,498,570,576,593,599,630,636,641,657,673,687,703,717,727,737],{"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},"\u002Fsignup",[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},"\u002Fdocs\u002Fsdks",[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\u002FCD 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},"explore-platform-features",[390],{"type":21,"value":391},"Explore Platform Features",{"type":15,"tag":24,"props":393,"children":394},{},[395],{"type":21,"value":396},"CredVault includes a comprehensive suite of tools for data management and analytics:",{"type":15,"tag":197,"props":398,"children":400},{"id":399},"data-analytics",[401],{"type":21,"value":402},"Data & Analytics",{"type":15,"tag":404,"props":405,"children":406},"ul",{},[407,422,436,450,464,478],{"type":15,"tag":408,"props":409,"children":410},"li",{},[411,420],{"type":15,"tag":50,"props":412,"children":413},{},[414],{"type":15,"tag":41,"props":415,"children":417},{"href":416},"\u002Fdocs\u002Ffeatures\u002Fnotebook",[418],{"type":21,"value":419},"Notebook",{"type":21,"value":421}," — Interactive data exploration and analysis",{"type":15,"tag":408,"props":423,"children":424},{},[425,434],{"type":15,"tag":50,"props":426,"children":427},{},[428],{"type":15,"tag":41,"props":429,"children":431},{"href":430},"\u002Fdocs\u002Ffeatures\u002Fml-experiments",[432],{"type":21,"value":433},"ML Experiments",{"type":21,"value":435}," — Track and compare machine learning models",{"type":15,"tag":408,"props":437,"children":438},{},[439,448],{"type":15,"tag":50,"props":440,"children":441},{},[442],{"type":15,"tag":41,"props":443,"children":445},{"href":444},"\u002Fdocs\u002Ffeatures\u002Forchestration",[446],{"type":21,"value":447},"Orchestration",{"type":21,"value":449}," — Automate data pipelines",{"type":15,"tag":408,"props":451,"children":452},{},[453,462],{"type":15,"tag":50,"props":454,"children":455},{},[456],{"type":15,"tag":41,"props":457,"children":459},{"href":458},"\u002Fdocs\u002Ffeatures\u002Flineage",[460],{"type":21,"value":461},"Lineage",{"type":21,"value":463}," — Track data flow through your system",{"type":15,"tag":408,"props":465,"children":466},{},[467,476],{"type":15,"tag":50,"props":468,"children":469},{},[470],{"type":15,"tag":41,"props":471,"children":473},{"href":472},"\u002Fdocs\u002Ffeatures\u002Fmetadata",[474],{"type":21,"value":475},"Metadata",{"type":21,"value":477}," — Catalog and govern your data",{"type":15,"tag":408,"props":479,"children":480},{},[481,490],{"type":15,"tag":50,"props":482,"children":483},{},[484],{"type":15,"tag":41,"props":485,"children":487},{"href":486},"\u002Fdocs\u002Ffeatures\u002Fai-assistant",[488],{"type":21,"value":489},"AI Assistant",{"type":21,"value":491}," — Get AI-powered code suggestions",{"type":15,"tag":197,"props":493,"children":495},{"id":494},"operations",[496],{"type":21,"value":497},"Operations",{"type":15,"tag":404,"props":499,"children":500},{},[501,514,528,542,556],{"type":15,"tag":408,"props":502,"children":503},{},[504,512],{"type":15,"tag":50,"props":505,"children":506},{},[507],{"type":15,"tag":41,"props":508,"children":510},{"href":509},"\u002Fdocs\u002Ffeatures\u002Fapi-keys",[511],{"type":21,"value":100},{"type":21,"value":513}," — Manage programmatic access",{"type":15,"tag":408,"props":515,"children":516},{},[517,526],{"type":15,"tag":50,"props":518,"children":519},{},[520],{"type":15,"tag":41,"props":521,"children":523},{"href":522},"\u002Fdocs\u002Ffeatures\u002Factivity-logs",[524],{"type":21,"value":525},"Activity Logs",{"type":21,"value":527}," — Audit all platform actions",{"type":15,"tag":408,"props":529,"children":530},{},[531,540],{"type":15,"tag":50,"props":532,"children":533},{},[534],{"type":15,"tag":41,"props":535,"children":537},{"href":536},"\u002Fdocs\u002Ffeatures\u002Fmonitoring",[538],{"type":21,"value":539},"System Monitoring",{"type":21,"value":541}," — Monitor platform health",{"type":15,"tag":408,"props":543,"children":544},{},[545,554],{"type":15,"tag":50,"props":546,"children":547},{},[548],{"type":15,"tag":41,"props":549,"children":551},{"href":550},"\u002Fdocs\u002Ffeatures\u002Fbilling",[552],{"type":21,"value":553},"Billing & Plans",{"type":21,"value":555}," — View usage and costs",{"type":15,"tag":408,"props":557,"children":558},{},[559,568],{"type":15,"tag":50,"props":560,"children":561},{},[562],{"type":15,"tag":41,"props":563,"children":565},{"href":564},"\u002Fdocs\u002Ffeatures\u002Fmigrations",[566],{"type":21,"value":567},"Migrations",{"type":21,"value":569}," — Import data from other systems",{"type":15,"tag":197,"props":571,"children":573},{"id":572},"cloud-development",[574],{"type":21,"value":575},"Cloud Development",{"type":15,"tag":404,"props":577,"children":578},{},[579],{"type":15,"tag":408,"props":580,"children":581},{},[582,591],{"type":15,"tag":50,"props":583,"children":584},{},[585],{"type":15,"tag":41,"props":586,"children":588},{"href":587},"\u002Fdocs\u002Ffeatures\u002Fcoder",[589],{"type":21,"value":590},"Coder",{"type":21,"value":592}," — Cloud-based development environments",{"type":15,"tag":197,"props":594,"children":596},{"id":595},"learning-paths",[597],{"type":21,"value":598},"Learning Paths",{"type":15,"tag":404,"props":600,"children":601},{},[602,616],{"type":15,"tag":408,"props":603,"children":604},{},[605,614],{"type":15,"tag":50,"props":606,"children":607},{},[608],{"type":15,"tag":41,"props":609,"children":611},{"href":610},"\u002Fdocs\u002Ffeatures\u002Fdata-workflow",[612],{"type":21,"value":613},"Complete Data Workflow",{"type":21,"value":615}," — See how everything works together",{"type":15,"tag":408,"props":617,"children":618},{},[619,628],{"type":15,"tag":50,"props":620,"children":621},{},[622],{"type":15,"tag":41,"props":623,"children":625},{"href":624},"\u002Fdocs\u002Ffeatures\u002Fbuilding-data-pipelines",[626],{"type":21,"value":627},"Building Data Pipelines",{"type":21,"value":629}," — Design production pipelines",{"type":15,"tag":29,"props":631,"children":633},{"id":632},"whats-next",[634],{"type":21,"value":635},"What's Next?",{"type":15,"tag":24,"props":637,"children":638},{},[639],{"type":21,"value":640},"Choose your next step based on your goals:",{"type":15,"tag":24,"props":642,"children":643},{},[644,649,651,655],{"type":15,"tag":50,"props":645,"children":646},{},[647],{"type":21,"value":648},"Data Exploration",{"type":21,"value":650}," — Start with ",{"type":15,"tag":41,"props":652,"children":653},{"href":416},[654],{"type":21,"value":419},{"type":21,"value":656}," to analyze your data",{"type":15,"tag":24,"props":658,"children":659},{},[660,665,667,671],{"type":15,"tag":50,"props":661,"children":662},{},[663],{"type":21,"value":664},"Machine Learning",{"type":21,"value":666}," — Use ",{"type":15,"tag":41,"props":668,"children":669},{"href":430},[670],{"type":21,"value":433},{"type":21,"value":672}," to build and track models",{"type":15,"tag":24,"props":674,"children":675},{},[676,681,683],{"type":15,"tag":50,"props":677,"children":678},{},[679],{"type":21,"value":680},"Automation",{"type":21,"value":682}," — Create scheduled workflows with ",{"type":15,"tag":41,"props":684,"children":685},{"href":444},[686],{"type":21,"value":447},{"type":15,"tag":24,"props":688,"children":689},{},[690,695,697,701],{"type":15,"tag":50,"props":691,"children":692},{},[693],{"type":21,"value":694},"Development",{"type":21,"value":696}," — Set up ",{"type":15,"tag":41,"props":698,"children":699},{"href":587},[700],{"type":21,"value":590},{"type":21,"value":702}," for cloud-based development",{"type":15,"tag":24,"props":704,"children":705},{},[706,711,713],{"type":15,"tag":50,"props":707,"children":708},{},[709],{"type":21,"value":710},"Integration",{"type":21,"value":712}," — Install an SDK for your programming language (Node.js, Python, Java, Go) in the ",{"type":15,"tag":41,"props":714,"children":715},{"href":273},[716],{"type":21,"value":276},{"type":15,"tag":24,"props":718,"children":719},{},[720,725],{"type":15,"tag":50,"props":721,"children":722},{},[723],{"type":21,"value":724},"Invite Your Team",{"type":21,"value":726}," — Bring colleagues into your workspace to collaborate on projects.",{"type":15,"tag":24,"props":728,"children":729},{},[730,735],{"type":15,"tag":50,"props":731,"children":732},{},[733],{"type":21,"value":734},"Set Up Automation",{"type":21,"value":736}," — Create webhooks or triggers to automate workflows based on data changes.",{"type":15,"tag":24,"props":738,"children":739},{},[740,742,748],{"type":21,"value":741},"Continue to the ",{"type":15,"tag":41,"props":743,"children":745},{"href":744},"\u002Fdocs\u002Fconcepts",[746],{"type":21,"value":747},"Core Concepts",{"type":21,"value":749}," section to deepen your understanding of how CredVault works.",{"title":7,"searchDepth":10,"depth":10,"links":751},[752,753,754,755,761,762,763,769],{"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":756},[757,759,760],{"id":199,"depth":758,"text":202},3,{"id":217,"depth":758,"text":220},{"id":281,"depth":758,"text":284},{"id":297,"depth":10,"text":300},{"id":367,"depth":10,"text":370},{"id":388,"depth":10,"text":391,"children":764},[765,766,767,768],{"id":399,"depth":758,"text":402},{"id":494,"depth":758,"text":497},{"id":572,"depth":758,"text":575},{"id":595,"depth":758,"text":598},{"id":632,"depth":10,"text":635},"markdown","content:docs:getting-started.md","content","docs\u002Fgetting-started.md","docs\u002Fgetting-started","md",1782233754778]