# HelixDB

> HelixDB Enterprise is an object-storage-backed graph database with integrated approximate vector search and BM25 full-text search. Queries are authored with Helix SDK DSLs or dynamic JSON and invoked over HTTP.

Quickstart (local instance requires Docker or Podman):

```bash
curl -sSL "https://install.helix-db.com" | bash   # install the helix CLI
helix init local                                  # scaffold helix.toml + examples/
helix start dev                                   # start a local instance
helix query dev -e 'writeBatch().varAs("alice", g().addN("User", { username: "alice" })).returning(["alice"])'
helix query dev -e 'readBatch().varAs("users", g().nWithLabel("User")).returning(["users"])'
```

Full walkthrough: https://docs.helix-db.com/cli/getting-started

## Getting Started
- [Introduction](https://docs.helix-db.com/database/introduction)
- [Local Development](https://docs.helix-db.com/database/local-development)
- [Rust](https://docs.helix-db.com/database/rust-project-setup): How to setup a Rust project to use HelixDB
- [TypeScript](https://docs.helix-db.com/database/typescript-project-setup): How to setup a TypeScript project to use HelixDB
- [Go](https://docs.helix-db.com/database/go-project-setup): How to setup a Go project to use HelixDB
- [Python](https://docs.helix-db.com/database/python-project-setup): How to setup a Python project to use HelixDB
- [Roadmap](https://docs.helix-db.com/database/roadmap): What we're building and what's coming next
- [Release Notes](https://docs.helix-db.com/database/release-notes): HelixDB Cloud Release Notes

## Concepts & Examples
- [Data Model](https://docs.helix-db.com/database/data-model)
- [Querying](https://docs.helix-db.com/database/querying)
- [Overview](https://docs.helix-db.com/database/querying-guide/overview)
- [Reading nodes and edges](https://docs.helix-db.com/database/querying-guide/reading-nodes)
- [Traversals](https://docs.helix-db.com/database/querying-guide/traversals)
- [Filtering, ordering, paging](https://docs.helix-db.com/database/querying-guide/filtering)
- [Projections](https://docs.helix-db.com/database/querying-guide/projections)
- [Mutations](https://docs.helix-db.com/database/querying-guide/mutations)
- [Vector and text search](https://docs.helix-db.com/database/querying-guide/search)
- [Advanced patterns](https://docs.helix-db.com/database/querying-guide/advanced)
- [Parameters and bundles](https://docs.helix-db.com/database/querying-guide/parameters-bundles)
- [Secondary Indexes](https://docs.helix-db.com/database/indexing/secondary)
- [Vector Indexes](https://docs.helix-db.com/database/indexing/vector)
- [Text Indexes](https://docs.helix-db.com/database/indexing/text)
- [Multi-Tenancy](https://docs.helix-db.com/database/multi-tenancy)

## Platform
- [Working with HelixDB Cloud](https://docs.helix-db.com/database/working-with-enterprise)
- [Architecture](https://docs.helix-db.com/database/architecture)
- [Guarantees](https://docs.helix-db.com/database/guarantees)
- [Security](https://docs.helix-db.com/database/security)
- [Tradeoffs](https://docs.helix-db.com/database/tradeoffs)
- [Limits](https://docs.helix-db.com/database/limits)

## Using the helix CLI
- [Getting started with HelixDB CLI](https://docs.helix-db.com/cli/getting-started): Install the Helix CLI v2, bootstrap a first app, run a local instance, and send your first dynamic query
- [Local Development](https://docs.helix-db.com/cli/workflows/local): Run a local v2 instance and iterate on dynamic JSON queries
- [Helix Cloud](https://docs.helix-db.com/cli/workflows/helix_cloud): Authenticate, link a project, and query a Helix Cloud cluster from the CLI
- [Configuration Guide](https://docs.helix-db.com/cli/configuration): Reference for helix.toml, ~/.helix/config, and credentials
- [Troubleshooting](https://docs.helix-db.com/cli/troubleshooting): Solutions to common issues and error messages in Helix CLI v2

## CLI Command Reference
- [CLI Command Reference](https://docs.helix-db.com/cli/command-reference): Complete reference for all Helix CLI v2 commands and options
- [helix add](https://docs.helix-db.com/cli/command-reference/add)
- [helix auth](https://docs.helix-db.com/cli/command-reference/auth)
- [helix chef](https://docs.helix-db.com/cli/command-reference/chef)
- [helix cluster](https://docs.helix-db.com/cli/command-reference/cluster)
- [helix delete](https://docs.helix-db.com/cli/command-reference/delete)
- [helix feedback](https://docs.helix-db.com/cli/command-reference/feedback)
- [helix init](https://docs.helix-db.com/cli/command-reference/init)
- [helix logs](https://docs.helix-db.com/cli/command-reference/logs)
- [helix metrics](https://docs.helix-db.com/cli/command-reference/metrics)
- [helix project](https://docs.helix-db.com/cli/command-reference/project)
- [helix prune](https://docs.helix-db.com/cli/command-reference/prune)
- [helix push](https://docs.helix-db.com/cli/command-reference/push)
- [helix query](https://docs.helix-db.com/cli/command-reference/query)
- [helix restart](https://docs.helix-db.com/cli/command-reference/restart)
- [helix skills](https://docs.helix-db.com/cli/command-reference/skills)
- [helix start](https://docs.helix-db.com/cli/command-reference/start)
- [helix status](https://docs.helix-db.com/cli/command-reference/status)
- [helix stop](https://docs.helix-db.com/cli/command-reference/stop)
- [helix sync](https://docs.helix-db.com/cli/command-reference/sync)
- [helix update](https://docs.helix-db.com/cli/command-reference/update)
- [helix workspace](https://docs.helix-db.com/cli/command-reference/workspace)