OptixLog Docs

OptixLog SDK & CLI

Python SDK and CLI for ingesting typed workflow nodes and managing projects on the OptixLog graph workflow platform.

OptixLog is a graph-based workflow and observability platform for technical teams running document-heavy engineering workflows — simulations, measurements, layouts, and more. Work is modeled as a graph of workflow nodes: each node carries typed properties, labels, file attachments, and parent/child edges, all organized inside projects that belong to an organization with teams, members, and an audit log.

What the SDK and CLI do

The Python SDK (optixlog) gives you three complementary surfaces:

  • Pipeline API — ingest typed workflow nodes into a project's graph.
  • Management API — read and manage project config, organization, teams, members, workflow nodes, and audit events.
  • Generated bindings — per-project typed Python classes (optixlog generate) that turn schema mismatches into static type errors before your code runs.

The CLI (optixlog) drives the developer workflow: login authenticates and saves your credentials, init selects your projects and writes optixlog.toml, and generate fetches schemas and emits a fully-typed optixlog_gen.py into your repo.

Mental model

Organization
  └── Project (one or more)
        ├── Teams & Members
        ├── Workflow-Node Graph
        │     ├── Node  (typed properties, labels, attachments)
        │     ├── Node ─origin→ Node ─forward→ Node
        │     └── ...
        └── Audit Log

The SDK exposes three import paths that map cleanly onto that model:

from optixlog import SDKClient          # core identity / session
from optixlog.management import Management  # read the graph and org
from optixlog.pipeline import Pipeline      # write nodes into the graph

After running optixlog generate, a fourth import path becomes available in your repo:

from optixlog_gen import OptixClient, Projects, SimulationNode

OptixClient wraps SDKClient and adds per-project overloaded ingest methods whose type signatures are derived from your organization's live schema.

Explore the docs

On this page