Skip to main content

Build, test, and publish an extension

This guide takes a separate extension project from source files to a package you can install in Glixo. It uses the published @glixo/glxdev CLI, version 0.3.5. The published CLI version used here is 0.3.5. No application source checkout is required.

Install the developer tools

Install Node.js 22 or newer, then:

npm install --global @glixo/glxdev@0.3.5
glxdev version
glxdev help

Choose C#, Go, Rust or TypeScript. The public build matrix lists exact compiler versions. The generated project includes its build settings and SDK files. Run glxdev doctor inside that project to see missing tools before building. For CLI sign-in and local publisher key storage, this CLI uses Windows DPAPI; on other systems use the browser publisher portal for account and key setup.

Create a project

For an Ollama model connection:

glxdev new --kind llm-provider --language typescript --package-id org.example.ollama --name "Ollama Provider" --publisher org.example --output ./ollama-provider
cd ollama-provider
glxdev doctor
glxdev check

For a tool, panel or service, choose a reference:

glxdev new --kind reference --reference workflow-text-stats --language typescript --package-id org.example.text-stats --name "Text statistics" --publisher org.example --output ./text-stats

Replace typescript with csharp, go or rust. Change --reference to accessible-theme, mail-watch, workspace-health, document-index, workspace-storage, conversation-insights, prompt-redactor or issue-lookup-mcp. The tutorials explain each example and link directly to its code.

What the generated files do

File Your responsibility
glixo.extension.json Name the extension, declare its features and permissions; see the manifest guide.
glixo.project.json Keep the component ID, language, recipe and artifact path aligned with the manifest.
src/ Implement the provider, tool or action.
ui/index.html Build the web panel, if your project contains one.
schemas/account.json Describe a provider's account settings, where the template includes this file.
package.json, project file or Cargo.toml Language dependencies and handler tests.
vendor/, wit/ SDK and interface definitions included by the scaffold.
dist/ Build and package outputs; generated by the CLI.

Edit your own src/ and JSON files. Add permissions when you add protected operations. Do not edit Glixo's private source or rebuild its application to add a feature.

Build and package

Run from your project directory:

glxdev check
npm ci --prefix vendor/glixo-extension-sdk --ignore-scripts
npm run build --prefix vendor/glixo-extension-sdk
npm ci --install-links
npm run build
glxdev pack
glxdev verify --output ./dist/package

npm run build runs the TypeScript project recipe and writes dist/glixo-extension.component.wasm. A web panel also ships its HTML and any declared assets. pack creates these files under dist/package/:

pack refuses to overwrite an existing output directory. During iteration, choose a fresh directory, for example glxdev pack --output ./dist/package-2, then glxdev verify --output ./dist/package-2. Use the same --output with verify and publish. Development install packages the current project again; run it from the source project after building, rather than from the ZIP output directory. Editing a packed ZIP or manifest invalidates its checksums and signature; change source and package again.

CLI build support

The TypeScript commands above use the build scripts shipped with the public project. The published CLI 0.3.5 has a recipe-output validation error for dependency directories and tries to compile mixed HTML/WASM components. Use the project's npm scripts for these examples. The same files can be built by the corrected CLI runner after it is published; there is no need to edit a compiler dependency or Glixo source. For C#, Go and Rust, follow the directly linked project README and pinned build matrix.

Test your code

For the TypeScript Text Stats and Accessible Theme examples, run npm test after building. These tests validate the handler, invalid inputs and storage behavior without an account or running Glixo. For other languages, use the test command in the directly linked example README.

For an LLM provider, the corrected CLI runner can run framed IPC tests against an installed extension-host executable. This fixture command also rebuilds the project; the published 0.3.5 recipe limitation described above applies until the corrected runner is published. Handler tests and installed-app checks remain available:

glxdev test --development --host-path "<installed-host-executable>"

Replace the placeholder with the actual extension-host executable distributed with your Glixo installation; GLIXO_EXTENSION_HOST_PATH can supply the same path. This is the extension host binary, not the desktop launcher or a URL. If your installation does not include it, you can still build, run the project's handler tests, and use the installed-app checks below. Do not obtain private Glixo source to build a test host.

The CLI's fixture driver exercises provider interfaces only. It does not execute arbitrary tool, panel or service tests, install a package, activate it, or contact a live model. A successful check or verify is a manifest/archive check, not a runtime test.

Set up signing

Development installation also checks package signatures. On Windows, sign in and register your publisher key before making an installable package:

glxdev auth login
glxdev auth status
glxdev publisher key create
glxdev publisher key register
glxdev publisher key status
glxdev publisher certificate import --file ./publisher-certificate.json

Sign in to the publisher portal with the same account. A certificate must be issued by Glixo for your registered key and publisher account. Import the issued JSON file; a key registration alone is not a certificate. The CLI checks the issuing root and account/key binding. If the certificate has not been issued, installation and publication remain unavailable. Keep private keys and tokens out of your project and ZIP.

If you packed before creating the key, pack again to a fresh output directory after setup. The CLI can sign with its protected local key; publish --dry-run lists any remaining blockers.

Install for development

Open Glixo and sign in to the account that will use the extension. Obtain the local cell/server URL for that running instance from its connection details. This is the authenticated Glixo API endpoint, not the developer website or frontend page. Use its exact scheme, hostname and port:

glxdev install --development --cell-url "<your-local-cell-url>"

The account needs permission to manage integrations. Development installation verifies and stores the package inactive. In Glixo, open the installed extension's Details, review the requested permissions, approve them, then select Start. Installation does not bypass consent. Providers require a separately approved account connection with the exact endpoint, HTTP methods and paths declared by the manifest.

Check it in Glixo

  1. Confirm the installed ID and version match your package.
  2. Open the panel, invoke the tool or menu item, or configure the provider account.
  3. Try one valid input and one invalid input; check the visible result or error.
  4. Restart the extension and check any saved state.
  5. Remove a permission and confirm protected operations stop.

For Ollama, follow the account connection and real request walkthrough. For panels and menus, use their panel and menu checklists. These installed-app checks cover behavior that a package verifier cannot.

Publish

Publication sends your package to the hosted catalog. First check it without uploading:

The developer portal Publish page with browser publishing disabled and the sign-in and certificate setup message visible.
The portal keeps browser publishing locked until you sign in, register a browser key, and import the publisher certificate. This image shows access setup only; it does not show the manifest or package workflow.
glxdev publish --dry-run --output ./dist/package
glxdev publish --output ./dist/package
glxdev publish --status --output ./dist/package

Run publish only after your handler tests and installed-app checks pass. It requires your signed-in publisher account, registered key and valid Glixo-issued certificate. To continue an interrupted submission of the same package, use glxdev publish --resume --output ./dist/package. Check the returned extension ID and version in the marketplace and catalog API.

The browser Publish page is another publishing route. It validates the generated glixo.module.json, accepts one ZIP per declared runtime identifier, and requires a browser key with its matching certificate. Browser publishing uses the dev channel. A certificate for a CLI key does not sign for a different browser key.

Example: package a review checklist

A skill is a Markdown instruction file for an agent. It does not need a WebAssembly component or compiler:

glxdev new --kind skills --package-id org.example.review-checklist --name "Review checklist" --publisher org.example --output ./review-checklist
cd review-checklist
glxdev check
glxdev build
glxdev pack
glxdev verify --output ./dist/package

Edit the generated instruction file under skills/ to describe the review procedure. A useful checklist can ask the agent to inspect changed files, check inputs and error paths, run the project's existing tests and report unresolved issues. See the public Review Checklist sample. Installation, consent and publishing still use the same package flow.

Troubleshoot a failed step

Symptom What to check
doctor reports a missing compiler Install the exact tool listed by your build recipe; reopen the shell after changing PATH.
check rejects a component or contribution Match contribution component to components[].id and the project build declaration; see manifest validation.
pack reports a missing artifact Build first; verify the manifest's relative path and declare every UI asset.
pack reports collision Choose a new --output; do not overwrite a package you may already have submitted.
Installation is denied Check the API URL, signed-in account, integration permission, publisher certificate and package digest.
Installed but invisible or inactive Approve permissions, start the extension, check its placement and supported platform.
Panel says it needs the bridge Open the installed panel inside Glixo; opening its HTML in a normal browser does not provide host access.
Provider HTTP is denied Match the manifest scope and separately approved account connection's methods and paths.