Install from Source | Geode Database

<h2 id="installing-geode-from-source" class="position-relative d-flex align-items-center group"> Installing Geode from Source <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installing-geode-from-source" aria-haspopup="dialog" aria-label="Share link: Installing Geode from Source"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>This guide covers building Geode from source using the Zig compiler. <h3 id="prerequisites" class="position-relative d-flex align-items-center group"> Prerequisites <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prerequisites" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h3> <h4 id="required-tools" class="position-relative d-flex align-items-center group"> Required Tools <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="required-tools" aria-haspopup="dialog" aria-label="Share link: Required Tools"> Share link </button> </h4><ul> <li>Zig 0.1.0+ - <a href="https://ziglang.org/download/" aria-label="Download from ziglang.org – opens in new window" target="_blank" rel="noopener noreferrer" >Download from ziglang.org ↗ </a> </li> <li>Git - For cloning the repository</li> <li>Make (optional) - For using build shortcuts</li> </ul> <h4 id="system-requirements" class="position-relative d-flex align-items-center group"> System Requirements <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="system-requirements" aria-haspopup="dialog" aria-label="Share link: System Requirements"> Share link </button> </h4>Minimum: <ul> <li>CPU: 2 cores</li> <li>RAM: 4GB</li> <li>Disk: 2GB free space</li> </ul> Recommended: <ul> <li>CPU: 4+ cores</li> <li>RAM: 8GB+</li> <li>Disk: 10GB+ free space</li> <li>SSD storage for optimal performance</li> </ul> <h4 id="supported-platforms" class="position-relative d-flex align-items-center group"> Supported Platforms <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="supported-platforms" aria-haspopup="dialog" aria-label="Share link: Supported Platforms"> Share link </button> </h4><ul> <li>Linux: Ubuntu 20.04+, Debian 11+, RHEL 8+, Arch Linux</li> <li>macOS: macOS 11+ (Big Sur or later)</li> <li>Windows: Windows 10+ with WSL2 (native Windows support coming soon)</li> </ul> <h3 id="quick-start" class="position-relative d-flex align-items-center group"> Quick Start <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="quick-start" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h3> <h4 id="clone-the-repository" class="position-relative d-flex align-items-center group"> Clone the Repository <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="clone-the-repository" aria-haspopup="dialog" aria-label="Share link: Clone the Repository"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">git clone https://github.com/codeprosorg/geode cd geode </code></pre></div> <h4 id="build" class="position-relative d-flex align-items-center group"> Build <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="build" aria-haspopup="dialog" aria-label="Share link: Build"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Debug build (faster compilation, slower runtime) make build # Or use zig directly zig build # Release build (optimized for performance) make release # Or use zig directly zig build -Doptimize=ReleaseFast </code></pre></div> <h4 id="verify-installation" class="position-relative d-flex align-items-center group"> Verify Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="verify-installation" aria-haspopup="dialog" aria-label="Share link: Verify Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check version ./zig-out/bin/geode --version # Run tests make test # Or use zig directly zig build test </code></pre></div> <h3 id="detailed-build-instructions" class="position-relative d-flex align-items-center group"> Detailed Build Instructions <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="detailed-build-instructions" aria-haspopup="dialog" aria-label="Share link: Detailed Build Instructions"> Share link </button> </h3> <h4 id="build-configurations" class="position-relative d-flex align-items-center group"> Build Configurations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="build-configurations" aria-haspopup="dialog" aria-label="Share link: Build Configurations"> Share link </button> </h4>Debug Build: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">zig build # Binary: ./zig-out/bin/geode # Characteristics: Fast compilation, debug symbols, slower runtime </code></pre></div>Release Build (Recommended): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">zig build -Doptimize=ReleaseFast # Binary: ./zig-out/bin/geode # Characteristics: Optimized for speed, no debug symbols </code></pre></div>Small Binary Build: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">zig build -Doptimize=ReleaseSmall # Binary: ./zig-out/bin/geode # Characteristics: Optimized for size, slower than ReleaseFast </code></pre></div>Safe Release Build: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">zig build -Doptimize=ReleaseSafe # Binary: ./zig-out/bin/geode # Characteristics: Runtime safety checks enabled </code></pre></div> <h4 id="build-options" class="position-relative d-flex align-items-center group"> Build Options <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="build-options" aria-haspopup="dialog" aria-label="Share link: Build Options"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable specific features zig build -Denable-tde=true # Transparent Data Encryption zig build -Denable-fle=true # Field-Level Encryption zig build -Denable-gpu=true # GPU acceleration (Vulkan/CUDA) # Disable features zig build -Denable-telemetry=false # Disable telemetry # Cross-compilation zig build -Dtarget=x86_64-linux # Linux x86_64 zig build -Dtarget=aarch64-linux # Linux ARM64 zig build -Dtarget=x86_64-macos # macOS x86_64 zig build -Dtarget=aarch64-macos # macOS ARM64 (Apple Silicon) </code></pre></div> <h4 id="make-targets" class="position-relative d-flex align-items-center group"> Make Targets <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="make-targets" aria-haspopup="dialog" aria-label="Share link: Make Targets"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Building make build # Debug build make release # Release build make verify-all # Build and run full verification # Testing make test # Run all tests make integration-test # Run integration tests only make geodetestlab # Run geodetestlab test suite # Code Quality make fmt # Format code make lint # Run linter make check # Type check # Benchmarks make bench # Run benchmarks # Documentation make docs # Generate documentation # Cleanup make clean # Remove build artifacts </code></pre></div> <h3 id="installation" class="position-relative d-flex align-items-center group"> Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installation" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h3> <h4 id="system-wide-installation" class="position-relative d-flex align-items-center group"> System-Wide Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="system-wide-installation" aria-haspopup="dialog" aria-label="Share link: System-Wide Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Build release binary make release # Install to /usr/local/bin (requires root) sudo cp zig-out/bin/geode /usr/local/bin/ # Verify installation geode --version </code></pre></div> <h4 id="user-installation" class="position-relative d-flex align-items-center group"> User Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="user-installation" aria-haspopup="dialog" aria-label="Share link: User Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Build release binary make release # Install to user bin directory mkdir -p ~/.local/bin cp zig-out/bin/geode ~/.local/bin/ # Add to PATH if not already present echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc source ~/.bashrc # Verify installation geode --version </code></pre></div> <h4 id="creating-a-service" class="position-relative d-flex align-items-center group"> Creating a Service <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="creating-a-service" aria-haspopup="dialog" aria-label="Share link: Creating a Service"> Share link </button> </h4>systemd (Linux): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create service file sudo tee /etc/systemd/system/geode.service > /dev/null <<EOF [Unit] Description=Geode Graph Database After=network.target [Service] Type=simple User=geode Group=geode ExecStart=/usr/local/bin/geode serve --listen 0.0.0.0:3141 --data-dir /var/lib/geode Restart=on-failure RestartSec=5s [Install] WantedBy=multi-user.target EOF # Create geode user sudo useradd -r -s /bin/false geode # Create data directory sudo mkdir -p /var/lib/geode sudo chown geode:geode /var/lib/geode # Enable and start service sudo systemctl daemon-reload sudo systemctl enable geode sudo systemctl start geode # Check status sudo systemctl status geode </code></pre></div>launchd (macOS): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create plist file cat > ~/Library/LaunchAgents/com.geodedb.geode.plist <<EOF <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict> <key>Label</key> <string>com.geodedb.geode</string> <key>ProgramArguments</key> <array> <string>/usr/local/bin/geode</string> <string>serve</string> <string>--listen</string> <string>0.0.0.0:3141</string> <string>--data-dir</string> <string>/usr/local/var/geode</string> </array> <key>RunAtLoad</key> <true/> <key>KeepAlive</key> <true/> </dict> </plist> EOF # Create data directory sudo mkdir -p /usr/local/var/geode sudo chown $(whoami) /usr/local/var/geode # Load service launchctl load ~/Library/LaunchAgents/com.geodedb.geode.plist # Check status launchctl list | grep geode </code></pre></div> <h3 id="post-installation" class="position-relative d-flex align-items-center group"> Post-Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="post-installation" aria-haspopup="dialog" aria-label="Share link: Post-Installation"> Share link </button> </h3> <h4 id="generate-self-signed-certificates-development" class="position-relative d-flex align-items-center group"> Generate Self-Signed Certificates (Development) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="generate-self-signed-certificates-development" aria-haspopup="dialog" aria-label="Share link: Generate Self-Signed Certificates (Development)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate CA key and certificate openssl req -x509 -newkey rsa:4096 -days 365 -nodes \ -keyout ca-key.pem -out ca-cert.pem \ -subj "/CN=Geode CA" # Generate server key and CSR openssl req -newkey rsa:4096 -nodes \ -keyout server-key.pem -out server-req.pem \ -subj "/CN=localhost" # Sign server certificate with CA openssl x509 -req -in server-req.pem -days 365 \ -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial \ -out server-cert.pem # Move to appropriate location sudo mkdir -p /etc/geode/certs sudo mv server-cert.pem server-key.pem /etc/geode/certs/ sudo chmod 600 /etc/geode/certs/server-key.pem </code></pre></div> <h4 id="initial-configuration" class="position-relative d-flex align-items-center group"> Initial Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="initial-configuration" aria-haspopup="dialog" aria-label="Share link: Initial Configuration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create config directory sudo mkdir -p /etc/geode # Create basic config file sudo tee /etc/geode/geode.yaml > /dev/null <<EOF server: listen: '0.0.0.0:3141' data_dir: '/var/lib/geode' tls: cert: '/etc/geode/certs/server-cert.pem' key: '/etc/geode/certs/server-key.pem' storage: page_size: 8192 page_cache_size: '1GB' logging: level: 'info' format: 'json' EOF </code></pre></div> <h4 id="start-server" class="position-relative d-flex align-items-center group"> Start Server <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="start-server" aria-haspopup="dialog" aria-label="Share link: Start Server"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># With default settings geode serve # With custom config geode serve --config /etc/geode/geode.yaml # With environment variables GEODE_DATA_DIR=/var/lib/geode geode serve --listen 0.0.0.0:3141 </code></pre></div> <h4 id="test-connection" class="position-relative d-flex align-items-center group"> Test Connection <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="test-connection" aria-haspopup="dialog" aria-label="Share link: Test Connection"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Interactive shell geode shell # Execute query geode query "RETURN 1 AS x" # Check server health curl -f http://localhost:8080/health || echo "Health check failed" </code></pre></div> <h3 id="development-setup" class="position-relative d-flex align-items-center group"> Development Setup <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="development-setup" aria-haspopup="dialog" aria-label="Share link: Development Setup"> Share link </button> </h3> <h4 id="ide-integration" class="position-relative d-flex align-items-center group"> IDE Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="ide-integration" aria-haspopup="dialog" aria-label="Share link: IDE Integration"> Share link </button> </h4>Visual Studio Code: <ol> <li>Install Zig extension</li> <li>Open workspace: <code>code .</code></li> <li>Configure settings:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "zig.path": "/usr/local/bin/zig", "zig.zls.path": "/usr/local/bin/zls", "zig.buildOnSave": true } </code></pre></div>Neovim (with LSP): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">require('lspconfig').zls.setup{ cmd = {'/usr/local/bin/zls'}, filetypes = {'zig'}, } </code></pre></div> <h4 id="running-tests" class="position-relative d-flex align-items-center group"> Running Tests <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="running-tests" aria-haspopup="dialog" aria-label="Share link: Running Tests"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># All tests make test # Integration tests only make geodetestlab # Specific test file zig test tests/test_parser.zig # With filter zig build test -Dtest-filter="CANARY" # With coverage (requires kcov) make coverage </code></pre></div> <h4 id="benchmarks" class="position-relative d-flex align-items-center group"> Benchmarks <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="benchmarks" aria-haspopup="dialog" aria-label="Share link: Benchmarks"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run all benchmarks make bench # Extract results make bench 2>&1 | bench_extract # Compare with baseline bench_regress --baseline old.json --current new.json </code></pre></div> <h4 id="code-quality" class="position-relative d-flex align-items-center group"> Code Quality <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="code-quality" aria-haspopup="dialog" aria-label="Share link: Code Quality"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Format code make fmt # Run linter make lint # Type checking zig build check # Generate documentation zig build docs </code></pre></div> <h3 id="troubleshooting" class="position-relative d-flex align-items-center group"> Troubleshooting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="troubleshooting" aria-haspopup="dialog" aria-label="Share link: Troubleshooting"> Share link </button> </h3> <h4 id="build-failures" class="position-relative d-flex align-items-center group"> Build Failures <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="build-failures" aria-haspopup="dialog" aria-label="Share link: Build Failures"> Share link </button> </h4>Zig version mismatch: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check Zig version zig version # Should be 0.1.0 or later # If not, download latest from ziglang.org </code></pre></div>Missing dependencies: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Update submodules git submodule update --init --recursive # Clean and rebuild make clean make build </code></pre></div>Out of memory during build: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Use single-threaded build zig build -j1 # Or increase swap space sudo fallocate -l 4G /swapfile sudo chmod 600 /swapfile sudo mkswap /swapfile sudo swapon /swapfile </code></pre></div> <h4 id="runtime-issues" class="position-relative d-flex align-items-center group"> Runtime Issues <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="runtime-issues" aria-haspopup="dialog" aria-label="Share link: Runtime Issues"> Share link </button> </h4>Port already in use: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Find process using port 3141 lsof -i :3141 # Kill process kill -9 <PID> # Or use different port geode serve --listen 0.0.0.0:3142 </code></pre></div>Permission denied: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check data directory permissions ls -la /var/lib/geode # Fix permissions sudo chown -R geode:geode /var/lib/geode sudo chmod -R 755 /var/lib/geode </code></pre></div>TLS certificate errors: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify certificate openssl x509 -in /etc/geode/certs/server-cert.pem -text -noout # Check key matches certificate openssl x509 -noout -modulus -in server-cert.pem | openssl md5 openssl rsa -noout -modulus -in server-key.pem | openssl md5 # Should match </code></pre></div> <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3><ul> <li><a href="/docs/configuration/" >Configuration Reference</a> - Configure Geode</li> <li><a href="/docs/ops/docker-deployment/" >Docker Deployment</a> - Run with Docker</li> <li><a href="/docs/getting-started/" >Getting Started Guide</a> - First steps with Geode</li> <li><a href="/docs/client-libraries/" >Client Libraries</a> - Connect from your application</li> </ul>