CommandBar is a JavaScript/TypeScript SDK designed to embed an AI-powered command bar and user assistance platform into web and mobile applications. It allows developers to add contextual help, searchable commands, in-app guides, checklists, nudges, and product tours, acting as a dynamic, embedded wiki for application functionality and support. The current stable npm package version is 1.14.0. While the npm package itself was last published two years ago, the underlying CommandBar service and its features, such as the AI Copilot and mobile support, are actively developed. Key differentiators include its AI capabilities for user assistance, robust mobile application support via dedicated SDKs (iOS, Android, React Native), and a comprehensive suite of tools for digital adoption and user engagement, contrasting with simpler command palettes or generic UI libraries.
npm install commandbarVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to initialize the CommandBar SDK with an organization ID and then 'boot' it for a specific user, including how to add a custom command. This sequence is essential for the CommandBar UI to appear and function correctly in your application.
Monitor CommandBar's official documentation for announcements regarding new versions or updates to their web SDK, and consider the implications of a less frequently updated npm package for new feature adoption.
Ensure `init(ORG_ID)` is executed once at the earliest possible stage in your application's lifecycle, typically before any UI components that might interact with CommandBar are mounted or rendered.
Always interact with the SDK methods via `window.CommandBar.methodName(...)` after `init` has successfully run. If `window.CommandBar` is undefined, ensure `init` was called correctly and the script had time to load.
Always pass your valid CommandBar organization ID to `init` and an authenticated user ID (or `null` for anonymous users) to `boot`. Validate these values before calling the functions.
Ensure `import { init } from 'commandbar'; init('YOUR_ORG_ID');` has been executed successfully before any calls to `window.CommandBar` methods. For non-module usage, verify the `<script>` tag for CommandBar's snippet is correctly placed and loaded in your HTML.Check that `init('YOUR_ORG_ID')` is called exactly once and completes without errors before any subsequent calls to `window.CommandBar.boot` or other `window.CommandBar` methods.Provide your unique CommandBar organization ID as the first argument to `init`, e.g., `init('YOUR_ORGANIZATION_ID');`.Pass a valid authenticated user ID string as the first argument to `window.CommandBar.boot`, e.g., `window.CommandBar.boot(authenticatedUserID);`. For anonymous users, pass `null` or an empty string as explicitly documented.
No dependency data recorded yet.