Preview Feature ​

This Preview feature is still being developed. We do not recommend using it in a production environment, because the feature might not be fully tested or optimized for performance, and related documentation could be incomplete.

Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the feature remains in Preview.

This guide walks you through creating, previewing, and deploying your first App on the App Platform (Preview). With an AI (artificial intelligence) coding assistant, you can move from a blank project to a working App in your Cribl.Cloud Organization in a few minutes.

Before You Begin ​

You need the following:

• A Cribl.Cloud Organization.
• Workspace Administrator access in the Organization (or in a dedicated App development Workspace) where you use Create App and Live Preview. See Roles, permissions, and governance in the Admin Guide.
• Node.js (version 18 or later) on your local machine.
• A terminal (macOS Terminal, a Linux shell, or Windows with Git Bash or WSL).
• An AI coding assistant, such as Cursor or Claude Code. The scaffolded project is designed to work with these tools.

Browser Permissions for Live Preview ​

For Live Preview, use Chrome, Edge, or Firefox. Safari blocks the embedded HTTP dev server on localhost when the Cribl UI is HTTPS. You can still test by packaging and installing the App.

Live Preview loads your App from a development server on your machine (often at a loopback address such as 127.0.0.1). The Cribl UI is served over HTTPS, so the browser can treat that as the public Cribl origin reaching your local network or local device. Recent Google Chrome and Microsoft Edge versions may block the connection until you explicitly allow it. For background, see Local Network Access in Chrome and Local Network Access in Microsoft Edge.

1. If the browser shows a permission prompt for your Cribl site, select Allow. The exact label may refer to local network or devices on your machine, depending on the browser and operating system.
2. If Live Preview stays blank and you do not see a prompt, open your browser’s site settings for your Cribl URL and enable access to the local network (or equivalent wording) for that origin.
3. On macOS, also check System Settings > Privacy & Security > Local Network and ensure your browser is allowed to access the local network. See Control access to your local network on Mac.

This requirement applies to Live Preview and other workflows where the embedded App is served from your computer. Installed Apps that load entirely from Cribl normally do not need this permission.

Step 1: Open Apps and Describe What You Are Building ​

1. On the top bar within any Cribl product, select Apps.

   

   

2. Select Create App. On the Create your App screen, enter a short description of what you want to start building. Then select Next.

   

   

Step 2: Enter App Metadata ​

On the next screen, enter App ID, Display Name, Description, Author, Version, and Minimum Cribl version. See Create and Scaffold for details on each field. Select Next.

Step 3: Scaffold the Project From the Script ​

The wizard shows how to scaffold the App from your IDE terminal. The on-screen instructions also tell you to run npm run dev after scaffolding and to return to Cribl to select Live Preview when the server is ready. The Live Preview control is on this same step.

1. Open a terminal in your IDE tool.
2. Set your shell working directory to the folder where you opened your IDE (or the parent folder where you want the scaffolded project created).
3. Select the tab that matches how you want to work: Using Cursor, Using Claude, or Generic. Each tab shows a command for that workflow.
4. Select Copy Script, paste the command into your terminal, and run it. For Using Cursor and Using Claude, the script scaffolds the App and launches Cursor or Claude Code. For Generic, the curl script scaffolds the project only. Open your editor and assistant yourself.

You still start the local development server from the project directory with npm run dev, as described in Step 4.

The script creates a folder named after your App ID. The folder contains a Node.js starter project, including:

• A working App skeleton you can extend immediately.
• A local development proxy that routes API calls to Cribl securely.
• The OpenAPI specification so your AI assistant knows which Cribl APIs are documented and available to the App.
• AGENTS.md, an instruction file that describes how to build a compliant App, authenticate, and use the App Platform (Preview) key-value (KV) store (including requiring encrypted KV for API keys and secrets). For REST paths, quotas, and encryption rules, see The KV store in the Builder Guide.

Leave the Create App wizard open in the browser while you run the dev server and open Live Preview from this step.

Step 4: Run the Dev Server and Open Live Preview ​

Use Chrome, Edge, or Firefox for Live Preview. Safari blocks the embedded HTTP dev server on localhost when the Cribl UI is HTTPS. See Browser Support.

1. In the scaffolded project directory, start the local development server as the wizard reminds you to do:

   npm run dev

   Copy

   Keep this terminal session running.

2. Return to the Create App wizard in Cribl (the scaffold and Live Preview step from the previous section).

3. Select Live Preview to open the embedded preview pane.

Your starter App appears inside Cribl. The preview uses live reload: when your AI assistant changes code locally, the Cribl view updates without a full page refresh.

If you later use Live Preview in a different Workspace, Organization, or deployment (for example, switching between Cribl.Cloud and a local environment), stop the development server and run npm run dev again first. Otherwise the App might not initialize in the preview iframe.

Step 5: Generate the App ​

This is where you shape the App for your use case. Your AI assistant reads AGENTS.md automatically, which gives it context on App Platform (Preview) limits and APIs.

1. In your AI assistant, describe what you want to build. You can paste this prompt verbatim:

   “Create an App that displays a table of Worker Groups, the number of Worker Nodes, and the number of integrations running in each Worker Group.”

2. Press Enter and let the tool build a plan and write the code.

When the run finishes, check the Live Preview window. The preview updates to show a working table that queries your live Cribl data.

To extend the App, continue prompting. For example: “Now let me select a Worker Group to see its list of integrations and view their configurations.” Describe the behavior you want, confirm it in Live Preview, and repeat as needed. Expect several iterations: assistants can drift from App Platform rules, so paste console errors back into the tool and ground changes in AGENTS.md. For a fuller discussion, see Expectations for Agent-Assisted Development in the Builder Guide.

Step 6: Deploy ​

When you are satisfied with the App, publish it from the preview.

1. Select Deploy in the corner of Live Preview. This packages the App locally and uploads it to Cribl in one step. Each time, the UI shows a Confirm deploy modal with fixed copy. Acknowledge it to finish the deploy.
2. In the terminal, stop the development server with Ctrl+C.

Step 7: Launch Your App ​

1. On the top bar, select Apps.
2. Select your App to open it.

The App runs inside Cribl, so you don’t need a local server.

Continue Local Development ​

To resume work on an App you already created:

1. Open the local project folder and run npm run dev again.
2. In the Cribl UI, go to Apps > Create App and advance through the wizard until you reach the scaffold and Live Preview step (use the same App ID as the existing project when the wizard asks for metadata).
3. Select Live Preview to reconnect the local server to the UI.

Troubleshooting ​