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
Understand Gluon and choose a workflow
One business model, three apps: which one to open for your task, and the terms the manual uses.
HOW TOSet up a tenant and load the sample
Create the break-glass admin, test sign-in with Entra ID and try Gluon on the contoso sample.
HOW TOSwitch workspaces and environments
Pick the namespace, environment and branch you work in before you ask or edit.
Chat and evidence 11
Ask a question and choose its scope
Pick what chat searches, ask in plain words and read what comes back.
HOW TOInspect citations, objects and lineage
Follow a claim to its passage and a field to the system it came from.
HOW TOFilter, save and export result sets
Narrow a list answer, keep it as a view or download it as CSV.
HOW TOHandle masked values and request access
Reveal a masked value if you may, and ask the owners for what is withheld.
HOW TOFind, share and delete conversations
Go back to an earlier chat, send it to a colleague and remove it when you are done.
HOW TOAttach files and report wrong answers
Give one chat extra text to work from, and tell the stewards when an answer is wrong.
HOW TOSee 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 TOSee and manage your memory
See what Gluon kept from your questions and your corrections, search it, correct an item and forget one.
HOW TOBrowse 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 TOAsk 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 TOBrowse 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
Explore the ontology canvas
Find a type, follow its links and see what depends on it before you change the model.
HOW TOCreate and edit model resources
Build objects, properties and links in forms or YAML, with every edit saved to the draft proposal.
HOW TORename resources and check dependants
See what uses a type, rename it without breaking consumers, and delete it safely.
HOW TOFix validation problems and test permissions
Read a validation code, apply its fix, and pin an access decision as a test in the proposal.
HOW TOBuild the ontology from documents
Let the ontology builder read your documents, then send the types, links and properties it proposes to review.
HOW TOTune what the builder looks for
Edit an extraction profile in the designer and preview what it finds in a few records of its source before you save it.
HOW TOReview live answers for Drift
Label the answers Drift set aside right or wrong, so the judge and the conflict detector are measured against people.
HOW TOWrite the golden set
Add and edit the golden questions Drift scores answers against, as Test answers in a proposal.
Review and deployment 6
Review what the swarm proposes
Accept, edit or reject mined suggestions, and see the evidence behind each one.
HOW TOReview, approve and merge a proposal
Check a change, collect the owners' approvals and merge it into main.
HOW TOPublish and compare versions
Turn main into a numbered version that never changes and can be deployed.
HOW TODeploy a version to an audience
Choose who gets a published version, on which channels, and in which stages.
HOW TORoll out, widen and roll back
Widen a deployment stage by stage on evidence, or return everyone to the prior version.
HOW TOExport, verify and import packages
Move a version between environments or tenants as one signed file.
Security and audit 3
Explain a person's access
Find out why someone is allowed, masked or refused, and see what they see.
HOW TOInvestigate an incident and verify the audit trail
Find the records behind an incident, check the chain and open a prompt with a reason.
HOW TOReview segments and policies
Check what each segment exposes and who a policy change lets in before it merges.
Administration 22
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 TOManage people, sessions and contractor expiry
See what a person can reach and why, and end their access when they leave.
HOW TOBind principals, groups, roles and markings
Map the groups and teams your ontology names to real directory objects in each environment.
HOW TOConfigure 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 TOApprove 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 TOConnect 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 TOCheck storage, sources and PII masking
Confirm search is up, see how fresh each source is, and test what the masker hides.
HOW TOConnect 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 TOSee 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 TOInspect 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 TORead 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 TOTry 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 TOCrawl 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 TOReview, 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 TOAdd a Query to a database
Turn a tested, read-only question to a database into a tool the planner may call.
HOW TOWrite 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 TOBrowse, 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 TOManage service accounts, tokens and keys
Issue scoped API keys to connectors and rotate signing keys without exposing a secret.
HOW TOManage notifications and delivery preferences
Keep up with what needs you and choose what reaches your inbox, while security notices stay on.
HOW TORead health, usage and capability value
See what is breached, who uses Gluon and how, and whether each Capability still earns its place.
HOW TORead 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 TODisable an action, Capability, source or model
Stop an unsafe element on every channel within seconds, without publishing a new version.
API and integrations 5
Use the generated REST API
Read objects, views and functions and submit actions under the caller's own permissions.
HOW TOConnect an MCP client
Offer an AI client the tools and resources a person may use, over OAuth.
HOW TOApprove OAuth clients and handle rate limits
Put a client on the allow-list, sign people in with PKCE and stay within the rate limit.
HOW TOHand an approved action to Agent OS
Let an Agent OS process carry out an action after Gluon has decided and approved it.
REFERENCEHTTP operations
All 368 HTTP operations the server registers, with method, route and summary.
Desktop assistant 14
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 TOSet 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 TOUse object cards, field explanations and cross-checks
Get help from the Mac assistant with the record you are working on.
HOW TOMonitor the desktop fleet and pause the assistant
See every Mac running the assistant and pause it for a device, a person or everyone.
HOW TOLink Gluon Desktop to your Gluon server
Sign in with the cloud, or keep Gluon Desktop local, and read what the lease states mean.
HOW TOUse the assistant blob with Gluon Desktop
Grant Accessibility, switch watching on and off, and see what the assistant sends and never sends.
HOW TOSee 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 TOTry 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 TOChoose 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 TOAdd 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 TOReview 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 TOAsk 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 TOSee, 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 TOTeach 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
Back up, restore and replay deletions
Recover Gluon from a backup without bringing back records deleted since.
HOW TOErase deleted source records and honour legal holds
Propagate deletes from a Source through the index, stored answers and audit payloads.
HOW TODeploy Gluon and investigate service failures
Run the API, workers, storage and model gateway, and find out why one of them stopped.
GOL language 32
GOL language guide
The complete GOL v1 contract: syntax, references, types, security, behaviour and evolution.
REFERENCEBuild and validate a first GOL package
Start from Contoso, change one business definition and test its effects.
REFERENCEPackage
A Package names your ontology, carries its version and dependencies, and sets which lint rules count as errors.
REFERENCEDomain
A Domain holds the types of one business area, its glossary and the other domains it may reference.
REFERENCEAudience
An Audience picks people by logical principal and directory attribute, minus the principals you exclude.
REFERENCEValueType
A ValueType is a scalar with its own checks and masking, such as an IBAN or a contract number.
REFERENCEStructType
A StructType groups typed fields into one value, such as Money, with no identity of its own.
REFERENCEEnumType
An EnumType lists the values a property may take, each with a title and a colour.
REFERENCESharedProperty
A SharedProperty is declared once and reused, so a renewal date means the same on every type.
REFERENCEObjectType
An ObjectType describes a business entity: its keys, properties, source mappings and how the product shows it.
REFERENCELinkType
A LinkType connects two object types, names the role at each end and says which data backs the link.
REFERENCEInterface
An Interface lists the properties, links and actions that every implementing object type must provide.
REFERENCESource
A Source declares where records come from, how far you trust them and whether their ACLs are mirrored.
REFERENCEActionType
An ActionType is a command people and clients can run, with parameters, preconditions, effects and approvals.
REFERENCEEventType
An EventType gives a domain event its payload, the actions that emit it and how long it is kept.
REFERENCEFunction
A Function is a typed calculation over objects that you can offer in chat, the API and MCP.
REFERENCEObjectView
An ObjectView is a named, filtered set of objects that chat scopes, apps and policies can point at.
REFERENCECapability
A Capability is one intended use: what it may read and run, for whom, on which models and within which budget.
REFERENCEExtension
An Extension adds properties, enum values or links to a type that another package or domain owns.
REFERENCEMarking
A Marking is a mandatory label: a reader must hold every marking on a type, a property and a row.
REFERENCERole
A Role grants ontology permissions, such as read, edit or deploy, at ontology, domain or type scope.
REFERENCEPolicy
A Policy allows or denies actions for subjects on resources, with row filters, context checks and obligations such as masking.
REFERENCESegment
A Segment is a named slice of the ontology. Deployments give segments to audiences.
REFERENCEDeployment
A Deployment offers a published version's segments and Capabilities to audiences on the channels you list.
REFERENCEMigration
A Migration lists the steps from one major version to the next, so old names keep working until their removeIn version.
REFERENCETest
A Test pins subjects and objects, then checks access, competency questions, invariants and golden answers.
REFERENCELayout
A Layout stores where the designer places each node and which domains are collapsed.
REFERENCEModel
A Model is one entry in the approved model matrix: provider, region, the markings it may receive and its fallbacks.
REFERENCESkill
A Skill is a tested instruction set: when it applies, the evidence it needs and how fresh, and how the answer is shaped.
REFERENCEQuery
A Query is a tested, read-only query against a live source that returns rows of an ontology type, served as a tool.
REFERENCEExtractionProfile
An ExtractionProfile says what the ontology builder's extraction model looks for in a source's content, and the limits it reads under.
REFERENCEValidation diagnostics
Every registered GLN diagnostic with its cause, fix and example.
Expression functions 7
CEL operators, macros and standard functions
The expression forms Gluon's type checker accepts, how to guard optional fields and where the runtime differs.
REFERENCEgluon.today()
Returns today's date in UTC.
REFERENCEgluon.now()
Returns the current time in UTC as a timestamp.
REFERENCEgluon.days(duration)
Returns the number of whole days in a duration.
REFERENCEgluon.clamp(value, minimum, maximum)
Keeps a number between a minimum and a maximum.
REFERENCEgluon.iban.valid(value)
Checks that a string is a well-formed IBAN with a correct check number.
REFERENCEgluon.money(amount, currency)
Builds a money value from an amount and a currency code.
CLI reference 39
gluon validate
Validate a package directory. Exit 1 when errors exist, 0 when only warnings do.
REFERENCEgluon diff
Compare two versions: change classes, minimum bump, dependents, aliases and access widening.
REFERENCEgluon test
Run the package's Test resources: access, competency and invariants (answers run under `gluon eval`).
REFERENCEgluon eval
Run the package's `answers` test cases, score them and write an immutable evaluation run.
REFERENCEgluon keygen
Create an Ed25519 key pair for signing packages during development.
REFERENCEgluon package
Export a signed .gluonpkg (tar.zst with manifest, src, compiled IR and schemas, reports, checksums).
REFERENCEgluon import
Verify a .gluonpkg and, only if every check passes, extract its src/ into DEST (a new directory).
REFERENCEgluon lock
Write gluon.lock: each dependency resolved to an exact version and content hash.
REFERENCEgluon compile
Compile a package to Gluon's versioned IR, the `ontology.json` file.
REFERENCEgluon gateway-config
Generate the LiteLLM gateway config from a package's approved Models.
REFERENCEgluon models import
Turn the entries of a model matrix file into Model resources.
REFERENCEgluon models approve
Approve a held Model version without a shadow run.
REFERENCEgluon models planner
Choose which Model plans an answer.
REFERENCEgluon fixtures
Rebuild the fixture packages from the Contoso example.
REFERENCEgluon fixtures generate
Generate a valid scale package for the designer's performance checks.
REFERENCEgluon fixtures corpus
Index a large synthetic contract corpus into a scratch Elastic index to measure result-set latency.
REFERENCEgluon source import
Load a package directory as the main snapshot of this tenant and environment and open the `draft` proposal.
REFERENCEgluon serve
Run the API server.
REFERENCEgluon reindex
Embed every indexed document again after the embedding model or its size changed.
REFERENCEgluon worker
Run the worker role: Gluon's periodic and queued jobs.
REFERENCEgluon dev-token
Print a bearer token for a local development persona.
REFERENCEgluon dev-miner-key
Print a fresh API key for the ontology builder's miner during development.
REFERENCEgluon dev-seed
Prepare a development laptop's first run.
REFERENCEgluon setup-token
Print a one-time token for the first-run setup wizard.
REFERENCEgluon audit-verify
Verify the audit log's hash chains against every external checkpoint; names the first broken entry.
REFERENCEgluon migrate
Apply the database migrations, master first, then audit.
REFERENCEgluon dev-db reset
Drop (FORCE) and create each database empty: the URLs given, else GLUON_DATABASE_URL and GLUON_AUDIT_DATABASE_URL.
REFERENCEgluon dev-db drop
Drop (FORCE) each database, if it exists.
REFERENCEgluon 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).
REFERENCEgluon 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.
REFERENCEgluon dev-db sql
Run the SQL script on stdin (several statements, one implicit transaction) in one database.
REFERENCEgluon dev-key create
Create a key in the file key service (GLUON_KEY_DIR) unless one of that name exists.
REFERENCEgluon erasure purge
Remove every accepted `propagate` deletion not yet purged: store, cited answers, audit payloads.
REFERENCEgluon erasure replay
Re-apply the deletion log after a restore, before traffic. Safe to repeat.
REFERENCEgluon erasure manifest
What was deleted, identifiers and times only, for the SIEM and the LLM provider.
REFERENCEgluon keys list
Every key and secret reference: id, provider and expiry. Never material.
REFERENCEgluon 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.
REFERENCEgluon audit-search
Search the audit log's metadata (never payloads) of this tenant and environment, oldest first.
REFERENCEgluon dev-pack
Write a dev recognition pack for Gluon Desktop from a GOL package (types, synonyms, value patterns, sample objects).