10 - --color: string@"nu-complete pueue color"# Colorize the output; auto enables color output when connected to a tty
11 - --config(-c): string # If provided, Pueue only uses this config file. This path can also be set via the "PUEUE_CONFIG_PATH" environment variable. The commandline option overwrites the environment variable!
12 - --profile(-p): string # The name of the profile that should be loaded from your config file
17 -# Enqueue a task for execution. There're many different options when scheduling a task. Check the individual option help texts for more information. Furthermore, please remember that scheduled commands are executed via your system shell. This means that the command needs proper shell escaping. The safest way to preserve shell escaping is to surround your command with quotes, for example: pueue add 'ls $HOME && echo "Some string"'
20 - --working-directory(-w): string # Specify current working directory
21 - --escape(-e) # Escape any special shell characters (" ", "&", "!", etc.). Beware: This implicitly disables nearly all shell specific syntax ("&&", "&>")
23 - --stashed(-s) # Create the task in Stashed state. Useful to avoid immediate execution if the queue is empty
24 - --delay(-d): string # Prevents the task from being enqueued until 'delay' elapses. See "enqueue" for accepted formats
25 - --group(-g): string # Assign the task to a group. Groups kind of act as separate queues. I.e. all groups run in parallel and you can specify the amount of parallel tasks for each group. If no group is specified, the default group will be used
26 - --after(-a): string # Start the task once all specified tasks have successfully finished. As soon as one of the dependencies fails, this task will fail as well
27 - --priority(-o): string # Start this task with a higher priority. The higher the number, the faster it will be processed
28 - --label(-l): string # Add some information for yourself. This string will be shown in the "status" table. There's no additional logic connected to it
29 - --print-task-id(-p) # Only return the task id instead of a text. This is useful when working with dependencies
59 -# Resume operation of specific tasks or groups of tasks. By default, this resumes the default group and all its tasks. Can also be used force-start specific tasks.
68 -# Restart failed or successful task(s). By default, identical tasks will be created and enqueued, but it's possible to restart in-place. You can also edit a few properties, such as the path and the command, before restarting.
70 - ...task_ids: string # Restart these specific tasks
71 - --all-failed(-a) # Restart all failed tasks across all groups. Nice to use in combination with `-i/--in-place`
72 - --failed-in-group(-g): string # Like `--all-failed`, but only restart tasks failed tasks of a specific group. The group will be set to running and its paused tasks will be resumed
73 - --start-immediately(-k) # Immediately start the tasks, no matter how many open slots there are. This will ignore any dependencies tasks may have
74 - --stashed(-s) # Set the restarted task to a "Stashed" state. Useful to avoid immediate execution
75 - --in-place(-i) # Restart the task by reusing the already existing tasks. This will overwrite any previous logs of the restarted tasks
76 - --not-in-place # Restart the task by creating a new identical tasks. Only applies, if you have the restart_in_place configuration set to true
77 - --edit(-e) # Edit the tasks' commands before restarting
78 - --edit-path(-p) # Edit the tasks' paths before restarting
79 - --edit-label(-l) # Edit the tasks' labels before restarting
80 - --edit-priority(-o) # Edit the tasks' priorities before restarting
84 -# Either pause running tasks or specific groups of tasks. By default, pauses the default group and all its tasks. A paused queue (group) won't start any new tasks.
96 - ...task_ids: string # Kill these specific tasks
97 - --group(-g): string # Kill all running tasks in a group. This also pauses the group
98 - --all(-a) # Kill all running tasks across ALL groups. This also pauses all groups
99 - --children(-c) # Deprecated: this switch no longer has any effect
100 - --signal(-s): string # Send a UNIX signal instead of simply killing the process. DISCLAIMER: This bypasses Pueue's process handling logic! You might enter weird invalid states, use at your own descretion
111 -# Edit the command, path, label, or priority of a stashed or queued task. By default only the command is edited. Multiple properties can be added in one go.
158 - ...query: string # Users can specify a custom query to filter for specific values, order by a column or limit the amount of tasks listed. Use `--help` for the full syntax definition
159 - --json(-j) # Print the current state as json to stdout. This does not include the output of tasks. Use `log -j` if you want everything
160 - --group(-g): string # Only show tasks of a specific group
161 - --help(-h) # Print help (see more with '--help')
164 -# Accept a list or map of JSON pueue tasks via stdin and display it just like "pueue status". A simple example might look like this: pueue status --json | jq -c '.tasks' | pueue format-status
170 -# Display the log output of finished tasks. Only the last few lines will be shown by default. If you want to follow the output of a task, please use the "follow" subcommand.
172 - ...task_ids: string # View the task output of these specific tasks
173 - --json(-j) # Print the resulting tasks and output as json. By default only the last lines will be returned unless --full is provided. Take care, as the json cannot be streamed! If your logs are really huge, using --full can use all of your machine's RAM
174 - --lines(-l): string # Only print the last X lines of each task's output. This is done by default if you're looking at multiple tasks
181 - task_id?: string # The id of the task you want to watch. If no or multiple tasks are running, you have to specify the id. If only a single task is running, you can omit the id
182 - --lines(-l): string # Only print the last X lines of the output before following
186 -# Wait until tasks are finished. By default, this will wait for all tasks in the default group to finish. Note: This will also wait for all tasks that aren't somehow 'Done'. Includes: [Paused, Stashed, Locked, Queued, ...]
215 -# Set the amount of allowed parallel tasks By default, adjusts the amount of the default group. No tasks will be stopped, if this is lowered. This limit is only considered when tasks are scheduled.
237 -# Enqueue a task for execution. There're many different options when scheduling a task. Check the individual option help texts for more information. Furthermore, please remember that scheduled commands are executed via your system shell. This means that the command needs proper shell escaping. The safest way to preserve shell escaping is to surround your command with quotes, for example: pueue add 'ls $HOME && echo "Some string"'
257 -# Resume operation of specific tasks or groups of tasks. By default, this resumes the default group and all its tasks. Can also be used force-start specific tasks.
261 -# Restart failed or successful task(s). By default, identical tasks will be created and enqueued, but it's possible to restart in-place. You can also edit a few properties, such as the path and the command, before restarting.
265 -# Either pause running tasks or specific groups of tasks. By default, pauses the default group and all its tasks. A paused queue (group) won't start any new tasks.
277 -# Edit the command, path, label, or priority of a stashed or queued task. By default only the command is edited. Multiple properties can be added in one go.
297 -# Accept a list or map of JSON pueue tasks via stdin and display it just like "pueue status". A simple example might look like this: pueue status --json | jq -c '.tasks' | pueue format-status
301 -# Display the log output of finished tasks. Only the last few lines will be shown by default. If you want to follow the output of a task, please use the "follow" subcommand.
309 -# Wait until tasks are finished. By default, this will wait for all tasks in the default group to finish. Note: This will also wait for all tasks that aren't somehow 'Done'. Includes: [Paused, Stashed, Locked, Queued, ...]
325 -# Set the amount of allowed parallel tasks By default, adjusts the amount of the default group. No tasks will be stopped, if this is lowered. This limit is only considered when tasks are scheduled.