Skip to content
dbx tools

Variable: CliServiceDefinitionSchema

const CliServiceDefinitionSchema: ZodReadonly<ZodObject<{ command: ZodOptional<ZodReadonly<ZodObject<{ arguments: ZodOptional<ZodReadonly<ZodArray<ZodString>>>; binName: ZodOptional<ZodString>; cwd: ZodOptional<ZodString>; entrypoint: ZodOptional<ZodString>; environment: ZodOptional<ZodReadonly<ZodRecord<ZodString, ZodString>>>; executable: ZodOptional<ZodString>; }, $strip>>>; dataDirectory: ZodOptional<ZodString>; icon: ZodString; id: ZodString; isTemplateIcon: ZodOptional<ZodBoolean>; menu: ZodOptional<ZodReadonly<ZodArray<ZodDiscriminatedUnion<[ZodReadonly<ZodObject<{ type: …; }, $strip>>, ZodReadonly<ZodObject<{ label: …; type: …; url: …; }, $strip>>, ZodReadonly<ZodObject<{ command: …; label: …; type: …; }, $strip>>], "type">>>>; name: ZodString; packageName: ZodString; pythonPackage: ZodOptional<ZodReadonly<ZodObject<{ dependencies: ZodDefault<ZodArray<ZodString>>; name: ZodString; python: ZodDefault<ZodString>; version: ZodOptional<ZodString>; }, $strip>>>; version: ZodOptional<ZodString>; }, $strip>>

Complete serializable definition consumed by the lifecycle manager and tray host.

CliServiceDefinition fields

Section titled “CliServiceDefinition fields”
  • pythonPackage (optional): Python runtime package installed into a service-owned uv environment.
  • pythonPackage.name: Python distribution name installed by uv.
  • pythonPackage.version (optional): Python distribution version. Defaults to the service package version.
  • pythonPackage.python (optional): Python version request passed to uv when creating the environment.
  • pythonPackage.dependencies (optional): Additional uv package specs installed beside the primary distribution.