Scripting with Imbricate

Imbricate support scripting with JavaScript or TypeScript. You can write scripts to automate the process of creating and updating your documentation.

The Imbricate Scripting feature is powered by Marked, a secure runtime for JavaScript and TypeScript that runs in a JavaScript sandboxed environment.

Getting Started

Taking example with Imbricate CLI as the interface, you can run the following command to create a new script file:

With any terminal shell, run the following command.

imbricate script create my-script

This will create a new script file and open it with your default configuration.

Write a Script

You can write your script in the script file that you created. Here is an example of a script that outputs “Hello, World!” to the terminal:

With any terminal shell, run the following command.

import { print } from "interface:io";
print("Hello, World!");

The interface:io is a built-in interface provided by the Imbricate CLI, the Front-end and interface layer of your setup.

• interface:* Front-end provided features
• origin:* Backend provided features
• core:* Core provided features

You could visit the origin specific or interface specific page to learn what each layer and setup provides for you script development.

Running a Script

To run a script, you can use the following command:

With any terminal shell, run the following command.

imbricate script run -s my-script

This will run the script and output the result to the terminal.