When true, stop at the first matching cartridge and return only that one. Useful for existence checks (e.g. workspace-type detection) where the full list is not needed — it lets the underlying scan short-circuit instead of enumerating every .project file. Filters from include/exclude are applied while scanning, so the returned cartridge always satisfies them.

Inherited from

FindCartridgesOptions.firstMatchOnly

include?

optional include: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:26

Cartridge names to include (if empty, all are included)

Inherited from

FindCartridgesOptions.include

maxDepth?

optional maxDepth: number

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:40

Maximum directory depth to recurse when searching for cartridges, expressed as the number of path segments to the marker file relative to the search directory. A cartridge at cartridges/<name>/.project is depth 3; the equivalent cartridge/*.properties marker at cartridges/<name>/cartridge/<name>.properties is automatically adjusted to depth 4 (maxDepth + 1) so both discovery methods honour the same logical cartridge-nesting bound. When omitted the search is unbounded (default). Bound this for untrusted/broad roots (e.g. an MCP server launched from a home directory) to avoid scanning the whole filesystem.

Inherited from

FindCartridgesOptions.maxDepth

onProgress()?

optional onProgress: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/code/deploy.ts:45

Callback for progress updates during long-running operations

Parameters

info

UploadProgressInfo

Returns

void

reload?

optional reload: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/code/deploy.ts:41

Reload (toggle activation to force reload) the code version after deploy

Interface: DeployOptions ​

Extends ​

Properties ​

activate? ​

delete? ​

exclude? ​

Interface: DeployOptions

Extends

Properties

activate?

delete?

exclude?