What you'll achieve By the end of this guide, you will have the TerminusDB client library installed and ready to use in your project.
This page covers installing the client library — the SDK you use to talk to TerminusDB from your application code. If you need to install the TerminusDB server itself, see Install TerminusDB (Docker).
Install the client
Requirements: Node.js 18+
Example: Bash
npm install terminusdbThis adds terminusdb to your package.json. You can also use it in a browser via CDN:
Example: HTML
<script src="https://unpkg.com/terminusdb/dist/terminusdb-client.min.js"></script>Verify:
Example: Bash
node -e "const T = require('terminusdb'); console.log('terminusdb', T.version || 'installed')"Requirements: Python 3.9+
It is recommended to install in a virtual environment:
Example: Bash
python3 -m venv ~/.virtualenvs/terminusdb
source ~/.virtualenvs/terminusdb/bin/activateThen install:
Example: Bash
python3 -m pip install terminusdb-clientVerify:
Example: Bash
python3 -c "import terminusdb_client; print('terminusdb-client', terminusdb_client.__version__)"Requirements: Rust nightly toolchain
Example: Bash
rustup install nightly && rustup default nightlyAdd to your Cargo.toml:
Example: toml
[dependencies]
terminusdb-client = { git = "https://github.com/ParapluOU/terminusdb-rs" }
tokio = { version = "1", features = ["full"] }
anyhow = "1"Add a rust-toolchain.toml to your project root:
Example: toml
[toolchain]
channel = "nightly"Next steps
- TypeScript Quickstart — Branch, edit, diff, and merge documents
- Python Quickstart — Same workflow in Python
- Rust Quickstart — Connect and query from Rust
- First 10 Minutes (curl) — Try TerminusDB without installing any SDK