Skip to manual
gluon

PRODUCT GUIDES / LANGUAGE REFERENCE

The Gluon manual

Find the guides and references you need to ask questions, approve actions, design the ontology, write it in GOL, review and deploy it, secure and administer Gluon, connect your applications, run it on your own servers and use it on your Mac.

155 pages found

Getting started 3

Chat and evidence 11

HOW TO

Ask a question and choose its scope

Pick what chat searches, ask in plain words and read what comes back.

HOW TO

Inspect citations, objects and lineage

Follow a claim to its passage and a field to the system it came from.

HOW TO

Filter, save and export result sets

Narrow a list answer, keep it as a view or download it as CSV.

HOW TO

Handle masked values and request access

Reveal a masked value if you may, and ask the owners for what is withheld.

HOW TO

Find, share and delete conversations

Go back to an earlier chat, send it to a colleague and remove it when you are done.

HOW TO

Attach files and report wrong answers

Give one chat extra text to work from, and tell the stewards when an answer is wrong.

HOW TO

See how an answer was made

Open the trace of an answer: the plan, every read with its source and age, the model and the checks.

HOW TO

See and manage your memory

See what Gluon kept from your questions and your corrections, search it, correct an item and forget one.

HOW TO

Browse Knowledge sources

See the organisation records you may read, by type, source and update time, search them, open the document behind a record and see them as a map.

HOW TO

Ask a collection of documents

See the company, team and personal collections you may read, add files to your own or your team's, give a collection instructions and pin a chat to one.

HOW TO

Browse and query your data

See the tables your answers read with what each column means, sample rows read as you, and query them in SQL as yourself, with history and private saved queries.

Actions and approvals 2

Ontology designer 8

Review and deployment 6

Security and audit 3

Administration 22

HOW TO

See the whole system on one map

Six views of everything you may see: the model, its records, who gets it, and the systems behind it.

HOW TO

Manage people, sessions and contractor expiry

See what a person can reach and why, and end their access when they leave.

HOW TO

Bind principals, groups, roles and markings

Map the groups and teams your ontology names to real directory objects in each environment.

HOW TO

Configure SSO, reconciliation and break-glass access

Connect Entra ID, prove the sign-in works before you enforce it, and keep a way in when the directory is down.

HOW TO

Approve models and test routing

Set which model serves each kind of work, decide which model versions may receive which marked evidence, and check where a request would go.

HOW TO

Connect AI services and their keys

Add the AI services Gluon may send text to, test them, rotate their keys, and stop one at once.

HOW TO

Check storage, sources and PII masking

Confirm search is up, see how fresh each source is, and test what the masker hides.

HOW TO

Connect a database or an MCP server, or keep files in Gluon

Add a source Gluon reads at question time, test it, choose its tables or tools, and move it to ready; or upload files to a Files source.

HOW TO

See what Gluon Ingest made of a Source's documents

List the documents a Source sent, with their status, pages, chunks, twin, masked values and duplicates, and open one in the inspector.

HOW TO

Inspect a document's chunks on the page

Open a document in the inspector: its pages with every chunk boxed, the stage tabs, the lenses and the chunk list.

HOW TO

Read Dutch laws per article

Turn on the nl-legal structure profile for a Source so laws are cut per article and lid, kept as article objects with their references and amendments, and read article first when a question names one.

HOW TO

Try retrieval as someone else

Run a question as a chosen person through the policy decision point and read the ranked passages with every score, boxed on their pages.

HOW TO

Crawl a website or knowledge base

Connect a Confluence, MediaWiki or documentation site, choose how far Gluon crawls it, and watch, refresh, pause or retry the crawl.

HOW TO

Review, try and enable tools

See every tool a source exposes, review an unknown one as read-only, try it, and give it an instruction.

HOW TO

Add a Query to a database

Turn a tested, read-only question to a database into a tool the planner may call.

HOW TO

Write and test skills

Start a skill from a template, edit it as a form or as YAML, try it in draft and run its tests.

HOW TO

Browse, correct and wipe memory

See everything Gluon kept and the records synced from sources, where they came from and how long they are valid, correct an item or wipe a source.

HOW TO

Manage service accounts, tokens and keys

Issue scoped API keys to connectors and rotate signing keys without exposing a secret.

HOW TO

Manage notifications and delivery preferences

Keep up with what needs you and choose what reaches your inbox, while security notices stay on.

HOW TO

Read health, usage and capability value

See what is breached, who uses Gluon and how, and whether each Capability still earns its place.

HOW TO

Read Drift and send the report

See whether answers stay right over time, per deployment and Capability, and download the PDF report for a sponsor.

HOW TO

Disable an action, Capability, source or model

Stop an unsafe element on every channel within seconds, without publishing a new version.

API and integrations 5

Desktop assistant 14

HOW TO

Get started and find your way around Gluon Desktop

Follow the welcome guide and Getting started, then use Chat, Knowledge, Memory, Settings, the bottom bar and the Develop menu.

HOW TO

Set up screen awareness and its controls

Turn screen awareness on, keep it away from apps, read documents with docling, and find where Gluon Desktop keeps its files.

HOW TO

Use object cards, field explanations and cross-checks

Get help from the Mac assistant with the record you are working on.

HOW TO

Monitor the desktop fleet and pause the assistant

See every Mac running the assistant and pause it for a device, a person or everyone.

HOW TO

Link Gluon Desktop to your Gluon server

Sign in with the cloud, or keep Gluon Desktop local, and read what the lease states mean.

HOW TO

Use the assistant blob with Gluon Desktop

Grant Accessibility, switch watching on and off, and see what the assistant sends and never sends.

HOW TO

See how an answer was made

Open the trace of an answer: the plan, each step with its measured count and time, the model, and the records the answer read.

HOW TO

Try the recogniser in the Playground

Paste what a screen shows, see what the recogniser finds on this Mac and in the cloud, and how a decision reads it.

HOW TO

Choose the AI that answers and discovers

Choose a model for each job, add connections, download a local model and run the Screen suggestion check.

HOW TO

Add sources: databases, MCP servers and folders

Add a PostgreSQL, MySQL or SQL Server database, an MCP server or a folder of notes; test it, see its tables and tools, choose what a read may call, read it and discover knowledge with AI.

HOW TO

Review discoveries and send types to your team

Review discoveries with their evidence, edit a type, keep it in the GOL folder and send it to the review inbox.

HOW TO

Ask about your knowledge in Chat

Start from the Chat home, ask questions over your local records, follow citations and lineage, and read the attention card.

HOW TO

See, correct and wipe what Gluon keeps

Browse the records your sources synced and what Gluon remembered from tools; correct an item or wipe it for good.

HOW TO

Teach Gluon a skill

Write a personal skill from a template, save it as a file checked against your types, and pin it for the next question.

Operations 3

GOL language 32

REFERENCE

GOL language guide

The complete GOL v1 contract: syntax, references, types, security, behaviour and evolution.

REFERENCE

Build and validate a first GOL package

Start from Contoso, change one business definition and test its effects.

REFERENCE

Package

A Package names your ontology, carries its version and dependencies, and sets which lint rules count as errors.

REFERENCE

Domain

A Domain holds the types of one business area, its glossary and the other domains it may reference.

REFERENCE

Audience

An Audience picks people by logical principal and directory attribute, minus the principals you exclude.

REFERENCE

ValueType

A ValueType is a scalar with its own checks and masking, such as an IBAN or a contract number.

REFERENCE

StructType

A StructType groups typed fields into one value, such as Money, with no identity of its own.

REFERENCE

EnumType

An EnumType lists the values a property may take, each with a title and a colour.

REFERENCE

SharedProperty

A SharedProperty is declared once and reused, so a renewal date means the same on every type.

REFERENCE

ObjectType

An ObjectType describes a business entity: its keys, properties, source mappings and how the product shows it.

REFERENCE

LinkType

A LinkType connects two object types, names the role at each end and says which data backs the link.

REFERENCE

Interface

An Interface lists the properties, links and actions that every implementing object type must provide.

REFERENCE

Source

A Source declares where records come from, how far you trust them and whether their ACLs are mirrored.

REFERENCE

ActionType

An ActionType is a command people and clients can run, with parameters, preconditions, effects and approvals.

REFERENCE

EventType

An EventType gives a domain event its payload, the actions that emit it and how long it is kept.

REFERENCE

Function

A Function is a typed calculation over objects that you can offer in chat, the API and MCP.

REFERENCE

ObjectView

An ObjectView is a named, filtered set of objects that chat scopes, apps and policies can point at.

REFERENCE

Capability

A Capability is one intended use: what it may read and run, for whom, on which models and within which budget.

REFERENCE

Extension

An Extension adds properties, enum values or links to a type that another package or domain owns.

REFERENCE

Marking

A Marking is a mandatory label: a reader must hold every marking on a type, a property and a row.

REFERENCE

Role

A Role grants ontology permissions, such as read, edit or deploy, at ontology, domain or type scope.

REFERENCE

Policy

A Policy allows or denies actions for subjects on resources, with row filters, context checks and obligations such as masking.

REFERENCE

Segment

A Segment is a named slice of the ontology. Deployments give segments to audiences.

REFERENCE

Deployment

A Deployment offers a published version's segments and Capabilities to audiences on the channels you list.

REFERENCE

Migration

A Migration lists the steps from one major version to the next, so old names keep working until their removeIn version.

REFERENCE

Test

A Test pins subjects and objects, then checks access, competency questions, invariants and golden answers.

REFERENCE

Layout

A Layout stores where the designer places each node and which domains are collapsed.

REFERENCE

Model

A Model is one entry in the approved model matrix: provider, region, the markings it may receive and its fallbacks.

REFERENCE

Skill

A Skill is a tested instruction set: when it applies, the evidence it needs and how fresh, and how the answer is shaped.

REFERENCE

Query

A Query is a tested, read-only query against a live source that returns rows of an ontology type, served as a tool.

REFERENCE

ExtractionProfile

An ExtractionProfile says what the ontology builder's extraction model looks for in a source's content, and the limits it reads under.

REFERENCE

Validation diagnostics

Every registered GLN diagnostic with its cause, fix and example.

Expression functions 7

CLI reference 39

REFERENCE

gluon validate

Validate a package directory. Exit 1 when errors exist, 0 when only warnings do.

REFERENCE

gluon diff

Compare two versions: change classes, minimum bump, dependents, aliases and access widening.

REFERENCE

gluon test

Run the package's Test resources: access, competency and invariants (answers run under `gluon eval`).

REFERENCE

gluon eval

Run the package's `answers` test cases, score them and write an immutable evaluation run.

REFERENCE

gluon keygen

Create an Ed25519 key pair for signing packages during development.

REFERENCE

gluon package

Export a signed .gluonpkg (tar.zst with manifest, src, compiled IR and schemas, reports, checksums).

REFERENCE

gluon import

Verify a .gluonpkg and, only if every check passes, extract its src/ into DEST (a new directory).

REFERENCE

gluon lock

Write gluon.lock: each dependency resolved to an exact version and content hash.

REFERENCE

gluon compile

Compile a package to Gluon's versioned IR, the `ontology.json` file.

REFERENCE

gluon gateway-config

Generate the LiteLLM gateway config from a package's approved Models.

REFERENCE

gluon models import

Turn the entries of a model matrix file into Model resources.

REFERENCE

gluon models approve

Approve a held Model version without a shadow run.

REFERENCE

gluon models planner

Choose which Model plans an answer.

REFERENCE

gluon fixtures

Rebuild the fixture packages from the Contoso example.

REFERENCE

gluon fixtures generate

Generate a valid scale package for the designer's performance checks.

REFERENCE

gluon fixtures corpus

Index a large synthetic contract corpus into a scratch Elastic index to measure result-set latency.

REFERENCE

gluon source import

Load a package directory as the main snapshot of this tenant and environment and open the `draft` proposal.

REFERENCE

gluon serve

Run the API server.

REFERENCE

gluon reindex

Embed every indexed document again after the embedding model or its size changed.

REFERENCE

gluon worker

Run the worker role: Gluon's periodic and queued jobs.

REFERENCE

gluon dev-token

Print a bearer token for a local development persona.

REFERENCE

gluon dev-miner-key

Print a fresh API key for the ontology builder's miner during development.

REFERENCE

gluon dev-seed

Prepare a development laptop's first run.

REFERENCE

gluon setup-token

Print a one-time token for the first-run setup wizard.

REFERENCE

gluon audit-verify

Verify the audit log's hash chains against every external checkpoint; names the first broken entry.

REFERENCE

gluon migrate

Apply the database migrations, master first, then audit.

REFERENCE

gluon dev-db reset

Drop (FORCE) and create each database empty: the URLs given, else GLUON_DATABASE_URL and GLUON_AUDIT_DATABASE_URL.

REFERENCE

gluon dev-db drop

Drop (FORCE) each database, if it exists.

REFERENCE

gluon dev-db seed

State the manual's captures need that no click reaches, only on its scratch databases (gluon_manual*): sso-test (a passing Test sign-in, as the Entra callback records it), reset-setup-tenant (every master row of the tenant manual-setup gone, so the first-run wizard shows again), native-session (a desktop session for Tom; prints its access token).

REFERENCE

gluon dev-db connection

Point every Postgres Source connection to the database named in an environment variable's URL (`postgres://user:password@host:port/name`) at that URL: host, port and user in its row, the password rotated in the key service. A demo world's API on Pushleft runs it before it serves, so a restored connection follows the managed database's address and login. No such connection is not an error.

REFERENCE

gluon dev-db sql

Run the SQL script on stdin (several statements, one implicit transaction) in one database.

REFERENCE

gluon dev-key create

Create a key in the file key service (GLUON_KEY_DIR) unless one of that name exists.

REFERENCE

gluon erasure purge

Remove every accepted `propagate` deletion not yet purged: store, cited answers, audit payloads.

REFERENCE

gluon erasure replay

Re-apply the deletion log after a restore, before traffic. Safe to repeat.

REFERENCE

gluon erasure manifest

What was deleted, identifiers and times only, for the SIEM and the LLM provider.

REFERENCE

gluon keys list

Every key and secret reference: id, provider and expiry. Never material.

REFERENCE

gluon keys rotate

Rotate a key (new version), the old one still decrypting during the overlap; a secret's new value is read from stdin with --stdin.

REFERENCE

gluon audit-search

Search the audit log's metadata (never payloads) of this tenant and environment, oldest first.

REFERENCE

gluon dev-pack

Write a dev recognition pack for Gluon Desktop from a GOL package (types, synonyms, value patterns, sample objects).