Install OntoCode and OntoCore¶
Canonical install page. Extension first (most users). CLI and CI are optional.
| Goal | Go here |
|---|---|
| Edit ontologies in VS Code / Cursor | Install the extension → First success (~10 min) |
| Optional CLI on macOS / Windows | Install CLI (cargo) · detail: macOS/Windows walkthrough |
| CI validate on Linux x64 | CI with release tarball |
| Which binary / crate do I need? | Which artifact? |
Most IDE users never need Rust
The OntoCode extension bundles ontocore-lsp. Install the extension and skip the CLI unless you need ontocore for CI, scripting, or validation outside the editor.
Docs vs Marketplace
Read the Docs latest may describe work after the last tag. Pins follow docs/TAGGED_RELEASE (0.26.2). See Versions & channels.
Wrong crate name
The GitHub repo is ontocode. The CLI crate is ontocore-cli (ontocore binary). Do not run cargo install ontocode.
Canonical pin: 0.26.2 (TAGGED_RELEASE).
1. VS Code / Cursor extension (recommended)¶
| Method | Platforms | Needs Rust? |
|---|---|---|
| Marketplace / Open VSX | Linux, macOS, Windows | No |
Release VSIX (ontocode-v0.26.2.vsix) | Same | No |
- Install OntoCode (
ontocode.ontocode). - If the store lags the latest GitHub tag, install the VSIX — Marketplace lag playbook.
- Open a folder of
.ttl/.obo/.owl/.rdf/.owxfiles. - Open the OntoCode activity bar.
Full steps (Trust, offline, custom lspPath): VS Code install details.
Next: First success (~10 min).
2. Optional CLI¶
| Method | Linux x64 | macOS | Windows | Needs Rust? |
|---|---|---|---|---|
cargo install ontocore-cli --locked --version 0.26.2 | Yes | Yes | Yes | Yes (1.88+) |
| Release CLI tarball | Yes | No | No | No |
Git clone + cargo run -- | Yes | Yes | Yes | Yes (1.88+) |
Cold compile
First cargo install often takes 15–30+ minutes. Prefer the Linux x64 tarball for CI — CI integration.
cargo install (macOS / Windows / any platform)¶
Prerequisites: Rust 1.88+; Windows needs MSVC Build Tools; macOS needs Xcode CLT (xcode-select --install).
cargo install ontocore-cli --locked --version 0.26.2
export PATH="$HOME/.cargo/bin:$PATH"
ontocore validate /path/to/your/ontologies
Longer macOS/Windows walkthrough: Install CLI.
Linux x64 release tarball (CI preferred)¶
See CI integration — download ontocore-v0.26.2-x86_64-unknown-linux-gnu.tar.gz, verify SHA256SUMS, run validate / classify.
From a clone¶
git clone https://github.com/eddiethedean/ontocode.git
cd ontocode
cargo run -- validate fixtures
3. What you can edit¶
Write-back: .ttl, .obo, .owl/.rdf, .owx. XML is semantic re-serialize (not Protégé byte-identical). JSON-LD / N-Triples / TriG stay read-only — Supported formats · Capabilities by format.
Related¶
| Topic | Doc |
|---|---|
| Full CLI / CI install matrix (all paths) | Install CLI & CI (detail) |
| VS Code options (offline, Restricted Mode) | vscode-install.md |
| Release integrity | release-integrity.md |
| Platform support | platform-compatibility.md |