Skip to content

Home

OntoCode documentation · v0.8.0

Ontology-as-code for Git and VS Code

Browse OWL/RDF in VS Code, edit Turtle ontologies, run EL/RL/RDFS reasoning, query and validate in CI, and index workspaces locally with the Rust OntoIndex engine.

VS Code extension Rust CLI Turtle write-back Query Workbench Manchester editor Reasoner (EL) OBO index Graph visualization ROBOT CLI

VS Code extension Rust & CLI What ships today

Not sure where to begin? Pick a path:

  • VS Code extension — Marketplace install, explorer, inspector, Query Workbench (no Rust required).
  • Rust & CLI — cargo install ontoindex-cli, crates.io libraries, CI and embedding.

You do not need to clone this repo to use the extension or cargo install ontoindex-cli.

Naming: OntoCode is the VS Code UI. OntoIndex is the engine (ontoindex CLI, ontoindex-* crates, ontoindex-lsp).

Choose your path

  • VS Code extension

    Browse, edit Turtle, run queries and the reasoner from the OntoCode activity bar.

    VS Code extension docs

  • Rust & CLI

    cargo install ontoindex-cli, embed ontoindex-* crates, validate and classify in CI.

    Rust & CLI docs

  • Reasoner

    Run EL/RL/RDFS classification, toggle inferred hierarchy, and open EL explanations.

    Reasoner guide

  • Authoring

    Edit labels, parents, and entities in .ttl files — in VS Code or via patch JSON.

    Authoring guide

  • Query Workbench

    Run SQL and SPARQL against your indexed workspace from VS Code.

    Query Workbench

  • Manchester editor

    Edit complex SubClassOf and EquivalentClasses axioms in Manchester syntax.

    Manchester guide

  • Graph visualization

    Open class, property, import, and neighborhood graphs from the explorer.

    Graph guide

  • OBO workflows

    Index .obo files, browse obo_id in the explorer, and run ROBOT from the CLI.

    OBO workflow guide

  • Questions?

    FAQ, troubleshooting, workspace limits, and security.

    Troubleshooting

What ships in v0.8.0

See the full matrix: What ships today.

Capability VS Code CLI
Browse classes, properties, individuals Yes via SQL
Edit labels, comments, parents (.ttl) Yes ontoindex patch
Complex SubClassOf / EquivalentClasses (Manchester) Yes ontoindex patch
Create / delete entities (.ttl) Yes ontoindex patch
SQL-like queries Query Workbench ontoindex query
SPARQL Query Workbench ontoindex sparql
Graph visualization (class, property, import, neighborhood) Yes (React) LSP ontoindex/getGraph
OBO format index + obo_id in explorer Yes ontoindex inspect
ROBOT interop — ontoindex robot validate\|merge\|report
React webview UI Inspector + graphs —
EL/RL/RDFS classification Reasoner panel ontoindex classify
Inferred hierarchy toggle Explorer via classify JSON
EL explanations (where available) Explanation panel ontoindex explain
Diagnostics / lint Problems panel ontoindex validate

Quick start

  1. Install OntoCode from the Marketplace
  2. Open a folder with .ttl, .owl, .obo, or other ontology files
  3. Open the OntoCode activity bar → browse Classes → click an entity
cargo install ontoindex-cli --locked
ontoindex query /path/to/ontologies "SELECT * FROM classes"
ontoindex validate /path/to/ontologies

git clone https://github.com/eddiethedean/ontocode.git
cd ontocode
cargo run -- query fixtures "SELECT * FROM classes"

Documentation map

Topic Link
VS Code extension (start here) guides/vscode-extension.md
Rust & CLI (start here) guides/rust-crates.md
What ships today (canonical) SHIPPED.md
Pick a task (all paths) guides/start-here.md
First success tutorial guides/first-success.md
Reasoner guides/reasoner.md
Query Workbench guides/query-workbench.md
Manchester editor guides/manchester-editor.md
Install VS Code vscode-install.md
Getting started (CLI) getting-started.md
CLI reference cli-reference.md
Troubleshooting troubleshooting.md
SQL virtual tables sql-reference.md
SPARQL sparql-reference.md
Graph visualization guides/graph-visualization.md
Refactoring guides/refactoring.md
OBO workflows guides/obo-workflow.md
ROBOT interop guides/robot-interop.md
Webview protocol webview-protocol.md
LSP API lsp-api.md
Errors reference errors.md
Patch JSON patch-reference.md
CI integration ci-integration.md
Examples examples/queries.md
Design specs & roadmap design/README.md
Contributing contributing.md

Release notes: CHANGELOG on GitHub