NQL

Utilities for using NQL

Install

Usage

Develop

This is a mono repository, managed with lerna.

1. git clone this repo & cd into it as usual
2. yarn setup is mapped to lerna bootstrap
   • installs all external dependencies
   • links all internal dependencies

To add a new package to the repo:

• install slimer
• run slimer new <package name>

Run

• yarn dev

Test

• yarn lint run just eslint
• yarn test run lint and tests

Publish

• yarn ship is an alias for lerna version
  • Bumps the version of all packages which have changed, also updating any packages which depend on them
  • Commits the new versions ("Published new versions"), tags the releases, and pushes to the remote (set GHOST_UPSTREAM to push to a remote other than origin)
  • Publishing to npm happens in CI: the Publish workflow picks up the version commit on main and publishes any package versions missing from the registry via OIDC trusted publishing
  • If a publish fails, re-run the Publish workflow from the Actions tab (with dry-run disabled) — it only publishes versions not yet on the registry, so it is safe to retry

Copyright & License

Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license.