{"library":"piral-cli","title":"Piral CLI","description":"Piral CLI (Command Line Interface) is the essential toolkit for developing microfrontends within the Piral framework. It empowers developers to scaffold new Piral instances (the host shell application) and individual Pilets (the microfrontend modules), and to manage their lifecycle including building, debugging, and deploying. The current stable version is 1.10.3, with a release cadence that includes frequent patch and minor updates to incorporate bug fixes, dependency upgrades, and enhance compatibility with evolving frontend frameworks like Angular and React. Its key differentiators include a bundler-agnostic architecture supporting popular tools such as Webpack, Vite, and Esbuild, strong TypeScript integration, and comprehensive features for orchestrating independently deployable microfrontends, including shared dependencies and dynamic runtime updates.","language":"javascript","status":"active","last_verified":"Thu Apr 23","install":{"commands":["npm install piral-cli"],"cli":{"name":"piral","version":null}},"imports":["import { run } from 'piral-cli';\n// or require for CJS\nconst { run } = require('piral-cli');","import type { CliPlugin } from 'piral-cli';","// In a Piral CLI plugin (e.g., piral-cli-my-plugin/index.js):\nmodule.exports = function (cliApi) { /* ... */ };"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# Install Piral CLI globally (recommended for convenience, or use npx)\nnpm install -g piral-cli\n\n# Or use npx for local execution:\n# npx piral new my-piral-app --framework react --install\nnpx piral new my-piral-app --framework react --install\ncd my-piral-app\nnpx piral debug\n\n# In a new terminal, scaffold a new pilet (microfrontend)\nnpx pilet new my-pilet --source my-piral-app@1.0.0 --install\ncd my-pilet\nnpx pilet debug","lang":"typescript","description":"Demonstrates how to create a new Piral instance (host application) and a Pilet (microfrontend), then run them in debug mode.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}