[{"data":1,"prerenderedAt":683},["ShallowReactive",2],{"doc-getting-started":3,"content-query-JDxdyuLTM9":4},null,{"_path":5,"_dir":6,"_draft":7,"_partial":7,"_locale":8,"title":9,"description":8,"sidebar_position":10,"body":11,"_type":677,"_id":678,"_source":679,"_file":680,"_stem":681,"_extension":682},"\u002Fdocs\u002Fgetting-started","docs",false,"","Getting Started",2,{"type":12,"children":13,"toc":663},"root",[14,23,40,46,53,67,72,78,83,138,144,203,208,214,269,295,301,308,313,319,413,425,431,451,457,477,483,488,494,635,645,657],{"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":30},"div",{"className":26,"ariaHidden":29},[27,28],"docs-page-hero","docs-page-hero--sky","true",[31,33],{"type":21,"value":32},"\n  ",{"type":15,"tag":34,"props":35,"children":39},"img",{"src":36,"alt":8,"width":37,"height":38},"\u002Fimages\u002Fdocs-illustrations\u002Fgetting-started.svg",128,72,[],{"type":15,"tag":41,"props":42,"children":43},"p",{},[44],{"type":21,"value":45},"By the end of this page you will have an account, a cluster, an API key, and (optionally) CIE installed.",{"type":15,"tag":47,"props":48,"children":50},"h2",{"id":49},"_1-create-your-account",[51],{"type":21,"value":52},"1. Create your account",{"type":15,"tag":41,"props":54,"children":55},{},[56,58,65],{"type":21,"value":57},"Open ",{"type":15,"tag":59,"props":60,"children":62},"a",{"href":61},"\u002Fsignup",[63],{"type":21,"value":64},"Sign up",{"type":21,"value":66},". Register with email, or continue with Google or GitHub.",{"type":15,"tag":41,"props":68,"children":69},{},[70],{"type":21,"value":71},"After you land in the dashboard, the left sidebar is your map of the product: clusters, workspace tools, monitoring, billing, and settings.",{"type":15,"tag":47,"props":73,"children":75},{"id":74},"_2-your-workspace",[76],{"type":21,"value":77},"2. Your workspace",{"type":15,"tag":41,"props":79,"children":80},{},[81],{"type":21,"value":82},"Every account sits in a workspace that holds:",{"type":15,"tag":84,"props":85,"children":86},"ul",{},[87,99,118,128],{"type":15,"tag":88,"props":89,"children":90},"li",{},[91,97],{"type":15,"tag":92,"props":93,"children":94},"strong",{},[95],{"type":21,"value":96},"Database clusters",{"type":21,"value":98}," — where collections and documents live",{"type":15,"tag":88,"props":100,"children":101},{},[102,107,109,116],{"type":15,"tag":92,"props":103,"children":104},{},[105],{"type":21,"value":106},"API keys",{"type":21,"value":108}," — programmatic access (",{"type":15,"tag":110,"props":111,"children":113},"code",{"className":112},[],[114],{"type":21,"value":115},"X-API-Key",{"type":21,"value":117},")",{"type":15,"tag":88,"props":119,"children":120},{},[121,126],{"type":15,"tag":92,"props":122,"children":123},{},[124],{"type":21,"value":125},"Team access",{"type":21,"value":127}," — invite people and manage roles (Team Management)",{"type":15,"tag":88,"props":129,"children":130},{},[131,136],{"type":15,"tag":92,"props":132,"children":133},{},[134],{"type":21,"value":135},"Billing",{"type":21,"value":137}," — plan, usage, invoices",{"type":15,"tag":47,"props":139,"children":141},{"id":140},"_3-create-your-first-cluster",[142],{"type":21,"value":143},"3. Create your first cluster",{"type":15,"tag":145,"props":146,"children":147},"ol",{},[148,161,172,193,198],{"type":15,"tag":88,"props":149,"children":150},{},[151,153,159],{"type":21,"value":152},"Go to ",{"type":15,"tag":59,"props":154,"children":156},{"href":155},"\u002Fcluster",[157],{"type":21,"value":158},"Clusters",{"type":21,"value":160},".",{"type":15,"tag":88,"props":162,"children":163},{},[164,166,171],{"type":21,"value":165},"Click ",{"type":15,"tag":92,"props":167,"children":168},{},[169],{"type":21,"value":170},"Create Cluster",{"type":21,"value":160},{"type":15,"tag":88,"props":173,"children":174},{},[175,177,183,185,191],{"type":21,"value":176},"Set a clear name (for example ",{"type":15,"tag":110,"props":178,"children":180},{"className":179},[],[181],{"type":21,"value":182},"dev-main",{"type":21,"value":184}," or ",{"type":15,"tag":110,"props":186,"children":188},{"className":187},[],[189],{"type":21,"value":190},"production",{"type":21,"value":192},").",{"type":15,"tag":88,"props":194,"children":195},{},[196],{"type":21,"value":197},"Pick region and tier for your workload (start small; you can scale later).",{"type":15,"tag":88,"props":199,"children":200},{},[201],{"type":21,"value":202},"Create and wait until status is healthy.",{"type":15,"tag":41,"props":204,"children":205},{},[206],{"type":21,"value":207},"From the cluster page you can open schema, rules, triggers, functions, webhooks, backups, scaling, and maintenance.",{"type":15,"tag":47,"props":209,"children":211},{"id":210},"_4-create-an-api-key",[212],{"type":21,"value":213},"4. Create an API key",{"type":15,"tag":145,"props":215,"children":216},{},[217,229,239,259,264],{"type":15,"tag":88,"props":218,"children":219},{},[220,221,227],{"type":21,"value":57},{"type":15,"tag":59,"props":222,"children":224},{"href":223},"\u002Fapi-keys",[225],{"type":21,"value":226},"API Keys",{"type":21,"value":228}," (not buried only under Settings).",{"type":15,"tag":88,"props":230,"children":231},{},[232,233,238],{"type":21,"value":165},{"type":15,"tag":92,"props":234,"children":235},{},[236],{"type":21,"value":237},"Create key",{"type":21,"value":160},{"type":15,"tag":88,"props":240,"children":241},{},[242,244,250,252,258],{"type":21,"value":243},"Name it for the app or environment (",{"type":15,"tag":110,"props":245,"children":247},{"className":246},[],[248],{"type":21,"value":249},"backend-dev",{"type":21,"value":251},", ",{"type":15,"tag":110,"props":253,"children":255},{"className":254},[],[256],{"type":21,"value":257},"ci-pipeline",{"type":21,"value":192},{"type":15,"tag":88,"props":260,"children":261},{},[262],{"type":21,"value":263},"Choose environment: production, staging, or development.",{"type":15,"tag":88,"props":265,"children":266},{},[267],{"type":21,"value":268},"Copy the secret immediately — it is shown once.",{"type":15,"tag":41,"props":270,"children":271},{},[272,274,279,281,287,289,294],{"type":21,"value":273},"Use the key as ",{"type":15,"tag":110,"props":275,"children":277},{"className":276},[],[278],{"type":21,"value":115},{"type":21,"value":280}," against ",{"type":15,"tag":110,"props":282,"children":284},{"className":283},[],[285],{"type":21,"value":286},"\u002Fapi\u002Fv1\u002Fdata\u002F\u003Ccollection>",{"type":21,"value":288}," (requests use the workspace’s active cluster). Details: ",{"type":15,"tag":59,"props":290,"children":292},{"href":291},"\u002Fdocs\u002Ffeatures\u002Fapi-keys",[293],{"type":21,"value":226},{"type":21,"value":160},{"type":15,"tag":47,"props":296,"children":298},{"id":297},"_5-connect-how-you-work",[299],{"type":21,"value":300},"5. Connect how you work",{"type":15,"tag":302,"props":303,"children":305},"h3",{"id":304},"dashboard",[306],{"type":21,"value":307},"Dashboard",{"type":15,"tag":41,"props":309,"children":310},{},[311],{"type":21,"value":312},"Browse and manage data from the cluster UI without writing client code.",{"type":15,"tag":302,"props":314,"children":316},{"id":315},"cie-terminal",[317],{"type":21,"value":318},"CIE (terminal)",{"type":15,"tag":320,"props":321,"children":325},"pre",{"className":322,"code":323,"language":324,"meta":8,"style":8},"language-bash shiki shiki-themes github-dark","curl -fsSL https:\u002F\u002Fcredvault.net\u002Finstall\u002Fcie | sh\n\ncie login\ncie whoami\ncie doctor\n","bash",[326],{"type":15,"tag":110,"props":327,"children":328},{"__ignoreMap":8},[329,364,373,387,400],{"type":15,"tag":330,"props":331,"children":334},"span",{"class":332,"line":333},"line",1,[335,341,347,353,359],{"type":15,"tag":330,"props":336,"children":338},{"style":337},"--shiki-default:#B392F0",[339],{"type":21,"value":340},"curl",{"type":15,"tag":330,"props":342,"children":344},{"style":343},"--shiki-default:#79B8FF",[345],{"type":21,"value":346}," -fsSL",{"type":15,"tag":330,"props":348,"children":350},{"style":349},"--shiki-default:#9ECBFF",[351],{"type":21,"value":352}," https:\u002F\u002Fcredvault.net\u002Finstall\u002Fcie",{"type":15,"tag":330,"props":354,"children":356},{"style":355},"--shiki-default:#F97583",[357],{"type":21,"value":358}," |",{"type":15,"tag":330,"props":360,"children":361},{"style":337},[362],{"type":21,"value":363}," sh\n",{"type":15,"tag":330,"props":365,"children":366},{"class":332,"line":10},[367],{"type":15,"tag":330,"props":368,"children":370},{"emptyLinePlaceholder":369},true,[371],{"type":21,"value":372},"\n",{"type":15,"tag":330,"props":374,"children":376},{"class":332,"line":375},3,[377,382],{"type":15,"tag":330,"props":378,"children":379},{"style":337},[380],{"type":21,"value":381},"cie",{"type":15,"tag":330,"props":383,"children":384},{"style":349},[385],{"type":21,"value":386}," login\n",{"type":15,"tag":330,"props":388,"children":390},{"class":332,"line":389},4,[391,395],{"type":15,"tag":330,"props":392,"children":393},{"style":337},[394],{"type":21,"value":381},{"type":15,"tag":330,"props":396,"children":397},{"style":349},[398],{"type":21,"value":399}," whoami\n",{"type":15,"tag":330,"props":401,"children":403},{"class":332,"line":402},5,[404,408],{"type":15,"tag":330,"props":405,"children":406},{"style":337},[407],{"type":21,"value":381},{"type":15,"tag":330,"props":409,"children":410},{"style":349},[411],{"type":21,"value":412}," doctor\n",{"type":15,"tag":41,"props":414,"children":415},{},[416,418,424],{"type":21,"value":417},"Full command map: ",{"type":15,"tag":59,"props":419,"children":421},{"href":420},"\u002Fdocs\u002Ffeatures\u002Fcie-cli",[422],{"type":21,"value":423},"CIE CLI",{"type":21,"value":160},{"type":15,"tag":302,"props":426,"children":428},{"id":427},"sdks",[429],{"type":21,"value":430},"SDKs",{"type":15,"tag":41,"props":432,"children":433},{},[434,436,442,444,449],{"type":21,"value":435},"Official packages ship as CredVault artifacts (",{"type":15,"tag":110,"props":437,"children":439},{"className":438},[],[440],{"type":21,"value":441},"credvault-edge",{"type":21,"value":443}," and language variants). Install from the artifacts or source under ",{"type":15,"tag":59,"props":445,"children":447},{"href":446},"\u002Fdocs\u002Fsdks",[448],{"type":21,"value":430},{"type":21,"value":450}," — do not assume every language is already on public npm\u002FPyPI\u002FMaven\u002FGo proxies.",{"type":15,"tag":302,"props":452,"children":454},{"id":453},"pragma-ide",[455],{"type":21,"value":456},"Pragma IDE",{"type":15,"tag":41,"props":458,"children":459},{},[460,462,468,470,476],{"type":21,"value":461},"For a native desktop ADE (terminal, editor, AI agent, Drive): ",{"type":15,"tag":59,"props":463,"children":465},{"href":464},"\u002Fdownload",[466],{"type":21,"value":467},"Download",{"type":21,"value":469}," and ",{"type":15,"tag":59,"props":471,"children":473},{"href":472},"\u002Fdocs\u002Ffeatures\u002Fpragma-ide",[474],{"type":21,"value":475},"Pragma overview",{"type":21,"value":160},{"type":15,"tag":47,"props":478,"children":480},{"id":479},"_6-store-data",[481],{"type":21,"value":482},"6. Store data",{"type":15,"tag":41,"props":484,"children":485},{},[486],{"type":21,"value":487},"CredVault uses a document model: clusters → databases → collections → JSON-like documents. Collections appear when you first insert. Add schema and access rules when you need stronger guarantees.",{"type":15,"tag":47,"props":489,"children":491},{"id":490},"explore-next",[492],{"type":21,"value":493},"Explore next",{"type":15,"tag":495,"props":496,"children":497},"table",{},[498,517],{"type":15,"tag":499,"props":500,"children":501},"thead",{},[502],{"type":15,"tag":503,"props":504,"children":505},"tr",{},[506,512],{"type":15,"tag":507,"props":508,"children":509},"th",{},[510],{"type":21,"value":511},"Goal",{"type":15,"tag":507,"props":513,"children":514},{},[515],{"type":21,"value":516},"Go here",{"type":15,"tag":518,"props":519,"children":520},"tbody",{},[521,539,554,571,586,601,618],{"type":15,"tag":503,"props":522,"children":523},{},[524,530],{"type":15,"tag":525,"props":526,"children":527},"td",{},[528],{"type":21,"value":529},"Clusters, schema, backups",{"type":15,"tag":525,"props":531,"children":532},{},[533],{"type":15,"tag":59,"props":534,"children":536},{"href":535},"\u002Fdocs\u002Ffeatures\u002Fdatabase",[537],{"type":21,"value":538},"Database Clusters",{"type":15,"tag":503,"props":540,"children":541},{},[542,547],{"type":15,"tag":525,"props":543,"children":544},{},[545],{"type":21,"value":546},"Keys and scopes",{"type":15,"tag":525,"props":548,"children":549},{},[550],{"type":15,"tag":59,"props":551,"children":552},{"href":291},[553],{"type":21,"value":226},{"type":15,"tag":503,"props":555,"children":556},{},[557,562],{"type":15,"tag":525,"props":558,"children":559},{},[560],{"type":21,"value":561},"Functions \u002F webhooks",{"type":15,"tag":525,"props":563,"children":564},{},[565],{"type":15,"tag":59,"props":566,"children":568},{"href":567},"\u002Fdocs\u002Ffeatures\u002Fserverless-functions",[569],{"type":21,"value":570},"Functions & Webhooks",{"type":15,"tag":503,"props":572,"children":573},{},[574,579],{"type":15,"tag":525,"props":575,"children":576},{},[577],{"type":21,"value":578},"Terminal + ML workflows",{"type":15,"tag":525,"props":580,"children":581},{},[582],{"type":15,"tag":59,"props":583,"children":584},{"href":420},[585],{"type":21,"value":423},{"type":15,"tag":503,"props":587,"children":588},{},[589,594],{"type":15,"tag":525,"props":590,"children":591},{},[592],{"type":21,"value":593},"Desktop IDE",{"type":15,"tag":525,"props":595,"children":596},{},[597],{"type":15,"tag":59,"props":598,"children":599},{"href":472},[600],{"type":21,"value":456},{"type":15,"tag":503,"props":602,"children":603},{},[604,609],{"type":15,"tag":525,"props":605,"children":606},{},[607],{"type":21,"value":608},"Health and alerts",{"type":15,"tag":525,"props":610,"children":611},{},[612],{"type":15,"tag":59,"props":613,"children":615},{"href":614},"\u002Fdocs\u002Ffeatures\u002Fmonitoring",[616],{"type":21,"value":617},"System Monitoring",{"type":15,"tag":503,"props":619,"children":620},{},[621,626],{"type":15,"tag":525,"props":622,"children":623},{},[624],{"type":21,"value":625},"Roles",{"type":15,"tag":525,"props":627,"children":628},{},[629],{"type":15,"tag":59,"props":630,"children":632},{"href":631},"\u002Fdocs\u002Ffeatures\u002Fteams-rbac",[633],{"type":21,"value":634},"Teams & Access",{"type":15,"tag":41,"props":636,"children":637},{},[638,643],{"type":15,"tag":92,"props":639,"children":640},{},[641],{"type":21,"value":642},"In the dashboard sidebar",{"type":21,"value":644}," (no separate docs pages): Notebook, ML Experiments, Orchestration, Lineage, Metadata, Omnigent, Team Management — open them after sign-in.",{"type":15,"tag":41,"props":646,"children":647},{},[648,650,656],{"type":21,"value":649},"Continue with ",{"type":15,"tag":59,"props":651,"children":653},{"href":652},"\u002Fdocs\u002Fconcepts",[654],{"type":21,"value":655},"Core Concepts",{"type":21,"value":160},{"type":15,"tag":658,"props":659,"children":660},"style",{},[661],{"type":21,"value":662},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":8,"searchDepth":10,"depth":10,"links":664},[665,666,667,668,669,675,676],{"id":49,"depth":10,"text":52},{"id":74,"depth":10,"text":77},{"id":140,"depth":10,"text":143},{"id":210,"depth":10,"text":213},{"id":297,"depth":10,"text":300,"children":670},[671,672,673,674],{"id":304,"depth":375,"text":307},{"id":315,"depth":375,"text":318},{"id":427,"depth":375,"text":430},{"id":453,"depth":375,"text":456},{"id":479,"depth":10,"text":482},{"id":490,"depth":10,"text":493},"markdown","content:docs:getting-started.md","content","docs\u002Fgetting-started.md","docs\u002Fgetting-started","md",1794695980407]