Skip to content
QuantCDN

quant search

Manage the QuantCDN on-site search index for the active project. Use it to add records, remove entries, clear the index, or check its status.

Synopsis

Section titled “Synopsis”
Terminal window
quant search <operation> [options]

Description

Section titled “Description”

The search index powers Quant Search. Deployments automatically index new content, but quant search lets you manage the index manually — useful for adding custom records after bulk imports or content migrations, or when debugging missing search results.

Arguments

Section titled “Arguments”
Name Description
operation One of status, index, unindex, clear (required).
Operation Behaviour
status Show the current state of the search index.
index Add or update records from a JSON file passed via --path.
unindex Remove a single URL from the index, passed via --path.
clear Remove every entry from the index. Asks for confirmation.

Options

Section titled “Options”
Flag Description
--path For index: path to a JSON file of search records. For unindex: the URL to remove.

Search record format

Section titled “Search record format”

The JSON file passed to index must be an array of records. Each record requires title, url, and content; summary, image, categories, and tags are optional:

[
  {
    "title": "This is a record",
    "url": "/blog/page",
    "summary": "The record is small and neat.",
    "content": "Lots of good content here. But not too much!"
  },
  {
    "title": "Fully featured search record",
    "url": "/about-us",
    "summary": "The record contains all the trimmings.",
    "content": "Lorem ipsum dolor sit amet...",
    "image": "https://www.example.com/images/about.jpg",
    "categories": ["Blog", "Commerce"],
    "tags": ["Tailwind", "QuantCDN"]
  }
]

Examples

Section titled “Examples”

Check index status

Section titled “Check index status”
Terminal window
quant search status

Add records from a JSON file

Section titled “Add records from a JSON file”
Terminal window
quant search index --path ./search-records.json

Remove a URL from the index

Section titled “Remove a URL from the index”
Terminal window
quant search unindex --path /blog/2026/old-post/

Clear the entire index

Section titled “Clear the entire index”
Terminal window
quant search clear

GitHub Actions

Section titled “GitHub Actions”

quantcdn/search-action runs the same operations in a workflow. Its latest release, v2.0.0, runs an older CLI (2.0.0) that adds /v1 to the endpoint itself, so its endpoint input takes the host without /v1:

- uses: quantcdn/search-action@f84efa8ea7a42ef305751608d6b7dea27d175a7f # v2.0.0
  with:
    customer: ${{ vars.QUANT_CUSTOMER }}
    project: ${{ vars.QUANT_PROJECT }}
    token: ${{ secrets.QUANT_TOKEN }}
    endpoint: https://api.quantgov.cloud   # QuantGov only; leave out on QuantCDN
    operation: index                       # index, unindex, status or clear
    path: search                           # a directory of *.json record files, or one file

The action reads the input path. The index-path and unindex-path inputs shown in the action’s README are not inputs of v2.0.0; a workflow that uses them passes and indexes nothing. A record file that fails to upload prints an Error: line and the step can still pass, so read the job log.

See also

Section titled “See also”