Skip to content

Getting started

Five-minute paths to success with OntoIndex (CLI) and OntoCode (VS Code).

Prerequisites

Path Requires
Minimum VS Code 1.85+ — see platform compatibility guide
cargo install CLI Rust 1.88+
Git clone + cargo run Rust 1.88+
Release binaries No Rust (download from GitHub Releases)

Follow First success in 10 minutes — Marketplace install, browse the explorer, edit .ttl in the Entity Inspector.

Details: vscode-install.md · authoring.md

git clone https://github.com/eddiethedean/ontocode.git
cd ontocode
cargo build --release

# Sample fixture ontology
cargo run -- inspect fixtures
cargo run -- query fixtures "SELECT short_name, labels FROM classes"
cargo run -- validate fixtures

The fixtures/ directory is included in the repository for examples and tests.

Path C — cargo install (no clone)

cargo install ontoindex-cli --locked

Use your own ontology directory — there is no fixtures/ folder outside a clone:

ontoindex inspect /path/to/your/ontologies
ontoindex query /path/to/your/ontologies "SELECT * FROM classes"
ontoindex validate /path/to/your/ontologies

Path D — Release binaries (no Rust)

  1. Open GitHub Releases for the latest v0.8.x tag.
  2. Download the CLI tarball for your platform (Linux x64 example below) or ontoindex-lsp-v0.8.0-<platform>.tar.gz / .zip for LSP-only use.
  3. Verify with SHA256SUMS — see release-integrity.md.
  4. Extract and run (replace 0.8.0 with your release tag):
VERSION=0.8.0
ASSET="ontoindex-v${VERSION}-x86_64-unknown-linux-gnu.tar.gz"
BIN="ontoindex-v${VERSION}-x86_64-unknown-linux-gnu"
tar xzf "${ASSET}"
chmod +x "${BIN}"
./"${BIN}" query /path/to/ontologies "SELECT * FROM classes"
./"${BIN}" validate /path/to/ontologies

Note: The extracted binary is versioned (not plain ontoindex). CLI release tarballs are Linux x64 only; macOS/Windows users should use cargo install ontoindex-cli or the bundled LSP inside the VSIX.

For VS Code, install the ontocode-*.vsix from the same release.

Next steps

Goal Document
What ships today SHIPPED.md
Query Workbench (VS Code) guides/query-workbench.md
Manchester editor guides/manchester-editor.md
Reasoner guides/reasoner.md
SQL queries sql-reference.md · query cookbook
SPARQL sparql-reference.md
Edit Turtle files authoring.md · patch-reference.md
CI validation ci-integration.md
LSP integration lsp-api.md
Troubleshooting troubleshooting.md · faq.md