Skip to content

Class pinnacle.process.CommandOpts

Options for a command.

Fields

cmd

cmd: string | string[]

The command to be run

shell_cmd nullable

shell_cmd?: string[]

An optional shell command that will be prefixed with cmd. Use this to spawn something with a shell.

envs nullable

envs?: table<string, string>

Any environment variables that should be set for the spawned process.

unique nullable

unique?: boolean

Causes the spawn to fizzle if the process is already running.

once nullable

once?: boolean

Causes the command to only spawn the process if it hasn't been spawned before within the lifetime of the compositor.