Skip to main content

SystemApi

@codebolt/plugin-sdk


Class: SystemApi

Defined in: CodeBolt/packages/pluginSdk/src/api/system.api.ts:17

Manages system-level operations and CLI integration.

This API provides functionality for installing and managing the CodeBolt CLI tool, checking installation status, and interacting with the system's file manager for folder operations.

Constructors

Constructor

new SystemApi(http: HttpClient): SystemApi;

Defined in: CodeBolt/packages/pluginSdk/src/api/system.api.ts:18

Parameters

ParameterType
httpHttpClient

Returns

SystemApi

Methods

checkCli()

checkCli(): Promise<CliStatus>;

Defined in: CodeBolt/packages/pluginSdk/src/api/system.api.ts:24

Returns

Promise<CliStatus>


installCli()

installCli(data?: InstallCliRequest): Promise<InstallCliResponse>;

Defined in: CodeBolt/packages/pluginSdk/src/api/system.api.ts:20

Parameters

ParameterType
data?InstallCliRequest

Returns

Promise<InstallCliResponse>


openFolder()

openFolder(data: OpenFolderRequest): Promise<OpenFolderResponse>;

Defined in: CodeBolt/packages/pluginSdk/src/api/system.api.ts:28

Parameters

ParameterType
dataOpenFolderRequest

Returns

Promise<OpenFolderResponse>