Skip to main content

SystemApi API

The systemApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

MethodDescription
checkCli
installCli
openFolder

Methods


checkCli

plugin.systemApi.checkCli(): Promise<CliStatus>

No parameters.

Returns: Promise<CliStatus>

Full reference →


installCli

plugin.systemApi.installCli(data?: InstallCliRequest): Promise<InstallCliResponse>
ParameterTypeRequiredDescription
dataInstallCliRequestNo

Returns: Promise<InstallCliResponse>

Full reference →


openFolder

plugin.systemApi.openFolder(data: OpenFolderRequest): Promise<OpenFolderResponse>
ParameterTypeRequiredDescription
dataOpenFolderRequestYes

Returns: Promise<OpenFolderResponse>

Full reference →