Examplary CLI

This package provides a command-line tool to develop and upload custom question types for the Examplary platform.

Read more in the 📘 Developer Documentation.

Usage

You can locally develop your custom question types using the Examplary CLI, by running the following command in your project directory:

npx @examplary/cli preview

To upload your custom question type, run the following command in a directory that contains a question-type.json or question-type.yml file:

npx @examplary/cli upload

You'll be required to pass a --key argument with your API key, which you can obtain from your Examplary account settings. You can also set the EXAMPLARY_API_KEY environment variable to avoid passing the key every time.

Validating

To run all of the pre-upload checks without uploading anything, use:

npx @examplary/cli validate

This verifies required fields, JSONata expressions (including responseProcessing.condition), response processing test cases, that components bundle, and the icon file. The same checks run automatically as part of upload.