@oml/server

Standalone OML server runtime package.

The only user-facing CLI is oml from @oml/cli. Use oml server start, oml server stop, and oml server status to manage the server.

Options

• --host, -h: bind host. Default: 127.0.0.1
• --port, -p: bind port. Default: 8080
• --workspace, -w: workspace root used to initialize the server. Default: current working directory
• --token: bearer token required for REST endpoints (except /health)
• --refresh-token: optional refresh token used by server auth refresh
• --token-expires-at: optional access-token expiration time (epoch ms)

Canonical CLI

From a local checkout:

node packages/cli/bin/cli.js server start

When installed from npm:

oml server start

Server management commands:

oml server start
oml server status
oml server stop

If the requested port is already occupied, startup fails immediately with a clear message naming the occupied host and port.

REST API

The server exposes only these endpoints:

• GET /health
• GET /openapi.json
• GET /v0/models
• POST /v0/query
• POST /v0/update
• POST /v0/fuzzysearch
• POST /v0/lint
• POST /v0/reason
• POST /v0/validate
• POST /v0/render
• POST /v0/export

Health check:

curl http://127.0.0.1:8080/health

Run a SPARQL query:

curl -X POST http://127.0.0.1:8080/v0/query \
  -H 'content-type: application/json' \
  -d '{
    "modelUri": "file:///absolute/path/to/model.oml",
    "sparql": "SELECT * WHERE { ?s ?p ?o } LIMIT 10"
  }'

Run update request:

curl -X POST http://127.0.0.1:8080/v0/update \
  -H 'content-type: application/json' \
  -d '{
    "operations": [
      {
        "createInstance": {
          "descriptionIri": "https://example.com/demo#",
          "instanceName": "alice"
        }
      }
    ]
  }'

Run fuzzy search:

curl -X POST http://127.0.0.1:8080/v0/fuzzysearch \
  -H 'content-type: application/json' \
  -d '{
    "text": "firefighter",
    "limit": 10
  }'