OptixLog Docs
Getting Started

Installation

Install the optixlog Python package and verify your setup.

Requirements

  • Python 3.10 or later.
  • pip (any recent version).

Install from PyPI

pip install optixlog

That installs the optixlog package and the optixlog CLI binary.

Install from source (development)

Clone or download python-sdk-spec/ and install in editable mode with the dev extras:

pip install -e ".[dev]"

Run this from inside the python-sdk-spec/ directory. The [dev] extras include type-checking dependencies (pyright, mypy) and test dependencies.

Verify the install

optixlog --version

You should see the version string printed to stdout. If the command is not found, ensure your Python environment's bin/ or Scripts/ directory is on PATH.

Next step

Authenticate with your API key.

Getting Started

The fastest path from zero to your first ingest — install, authenticate, generate bindings, and write a node into the graph.

Authentication

Obtain an API key, run optixlog login, and understand where credentials are stored.

On this page

RequirementsInstall from PyPIInstall from source (development)Verify the installNext step