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

Prevents the spawn from occurring 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.

pipe_stdin nullable

pipe_stdin?: boolean

Sets up a pipe to allow the config to write to the process's stdin.

The pipe will be available through the spawned child's stdin.

pipe_stdout nullable

pipe_stdout?: boolean

Sets up a pipe to allow the config to read from the process's stdout.

The pipe will be available through the spawned child's stdout.

pipe_stderr nullable

pipe_stderr?: boolean

Sets up a pipe to allow the config to read from the process's stderr.

The pipe will be available through the spawned child's stderr.