Getting started

Install GraphArch and point it at your content. Start without configuration; add publication hints when you need to control the result.

Standalone binaries are available from GitHub Releases. Package-manager channels remain subject to their separate publication status below.

Install a prebuilt binary

Download the archive for your platform from GitHub Releases. Each archive has an adjacent SHA-256 checksum file. Verify the download, extract it, and put grapharch (or grapharch.exe on Windows) in a directory on your PATH.

The release platforms are:

SystemCPURequirement
Linuxx64 or ARM64glibc 2.28 or newer
macOSIntel or Apple siliconmacOS 11 or newer
Windowsx64 or ARM64Native Windows executable

Musl-based Linux distributions and 32-bit systems are not included in this release matrix. Select the archive for the system where GraphArch will run.

Install with cargo-binstall

With cargo-binstall installed:

cargo binstall grapharch --version 0.2.4

This downloads the prebuilt executable for your system. Unsupported platforms or missing release files fail installation.

Other installation channels

These commands require a published package version; see PyPI and npm for available versions. Homebrew requires its separate tap publication. Each channel installs the same CLI:

ChannelInstall or run
Homebrewbrew install legra-ai/tap/grapharch
Python with uvuv tool install grapharch, or uvx grapharch --help for an isolated run
Python with pippython -m pip install grapharch
npm project dependencynpm install --save-dev @ekgf/grapharch, then npx grapharch --help

For a repeatable CI build, pin an exact released version instead of tracking the latest package. A missing binary or unsupported platform is an installation error; these installers do not silently compile GraphArch from source.

Check the installation

grapharch --version
grapharch publication --help

If the command is not found, check that its installation directory is on your PATH. In an npm project, use npx grapharch instead of grapharch.

Start without configuration

For OWL class diagrams, install Java and PlantUML on PATH first. Smetana, the layout engine used by GraphArch, is included in PlantUML; Graphviz is not required. The GraphArch GitHub Action installs a checksum-verified renderer during setup. Markdown-only builds and rendering a retained documentation graph do not invoke PlantUML. See OWL class diagrams.

grapharch build ./ontology.ttl
grapharch build ./my-project --output output/preview
# From a directory containing Markdown or RDF:
grapharch build

Open output/grapharch/site/index.html (or output/preview/site/index.html with the override). The output also contains documentation.nq: source content, provenance, inferred publication definitions, and the resolved plan. HTML is rendered from that graph, so it can be restored without the source files.

Supported inputs are Markdown and RDF in .ttl, .rdf (RDF/XML), .nt, .nq, .trig, and .n3 files. Local images are collected as assets. No frontmatter, GraphArch vocabulary, or extra ontology annotations are needed. Markdown titles come from frontmatter when present, otherwise the first heading or filename. A single ontology's label supplies the site title; otherwise GraphArch uses the home page title or directory name. RDF definitions and relationships come from the supplied graph; missing descriptions are not invented. Shared subjects are documented once, using statements from all collected RDF files.

The default website uses neutral styling and navigable pages. README.md or index.md is the home page; an RDF reference or generated contents page supplies the home page when neither exists. Git provenance is collected for checkouts. No publishing authority, approval status, release date, or license is assumed.

Discovery is deterministic and limited to 256 source files and 4,096 directory entries. Hidden directories, underscore-prefixed entries, node_modules, target, dist, build, output, vendor, venv, and the selected output directory are excluded. Symlinks are rejected. Large repositories should select a content subdirectory or configure a scoped publication; the quick RDF reference is limited to 20,000 named typed subjects.

For an existing MkDocs repository, the same command reads mkdocs.yml or mkdocs.yaml and translates supported metadata, navigation, and content settings. See Import MkDocs sites for supported constructs, explicit diagnostics, and the distinction between content import and theme reproduction.

A root grapharch.ttl, project.ttl, or .grapharch/project.ttl is treated as explicit configuration: a single configured target uses the existing configured publication pipeline. Invalid configuration remains an error. For multiple targets or another configuration filename, use the explicit publication commands below.

Publish your project

Choose the guide for the publication you want:

PublicationGuide
Related ontologies with linked vocabulary chaptersOntology families
A standards-style specification and PDFSpecification renderer
A documentation website of guides and topicsSelf-hosted documentation
Separate specification, companion website, and PDFPublication families

For an ontology family, define your project and target in grapharch.ttl, then read the existing repository checkout directly:

grapharch publication build-family \
  --local-repository . \
  --definitions grapharch.ttl \
  --project urn:example:project \
  --target urn:example:specification \
  --output-root output/docs

Replace the example identifiers with those in your configuration. The ontology-family guide explains membership, namespace hints, remote repositories, and the generated files. Source files stay in your project; generated files go under the chosen output directory.

Use the same pinned GraphArch version and publication command in CI. Publish the generated files to GitHub Pages or another static host. Browse the showcase gallery for working output before choosing your publication style.

Build from source

Build from source when contributing or testing unreleased changes. Normal installation uses the prebuilt channels above.

Install the development prerequisites, then run:

git clone https://github.com/EKGF/grapharch.git
cd grapharch
cargo build --release --locked
./target/release/grapharch --help

On Windows, the executable is target\release\grapharch.exe. To generate this repository's documentation with the built executable:

./target/release/grapharch publication build-site \
  --source docs \
  --definitions docs/grapharch.ttl \
  --project urn:grapharch:docs \
  --target urn:grapharch:docs:website \
  --output-root output/docs

Open output/docs/site/index.html, or serve that directory with your preferred local web server. The examples guide contains contributor commands for running individual fixtures and their tests.

For separate collection, planning, rendering, and inspection commands, see the publication pipeline guide. Check the status page before relying on a planned capability.

Search documentation

Enter words to search this site.