pueue-stash

Stash an enqueued task

$ pueue stash [task_id]

$ pueue stash [task_id] [task_id]

$ pueue start [task_id]

$ pueue enqueue [task_id]

pueue stash [OPTIONS] <TASK_IDS>...

<TASK_IDS>...
    One or more space-separated numeric IDs of the tasks to be stashed.

--all
    Stashes all tasks currently in the queue. This option cannot be used in conjunction with specific TASK_IDS.

-g, --group <GROUP>
    Specifies the group from which tasks should be stashed. If this flag is omitted, the default group is assumed.

--force
    Skips the confirmation prompt when stashing tasks, making it suitable for scripting or automated workflows.

-h, --help
    Displays a short help message for the stash subcommand, showing available options and arguments.

pueue-stash is a subcommand of the pueue task management system. It allows users to temporarily remove tasks from the active Pueue queue without permanently deleting them.

Stashed tasks are moved to a separate "stashed" state, making them invisible and inactive in the main queue. This feature is useful for decluttering the queue, pausing work on specific tasks, or holding tasks for later execution without losing their state or definition. Stashed tasks can be retrieved and re-added to the active queue using the pueue restore command. It supports stashing specific tasks by ID, all tasks, or tasks within a particular group.

Stashed tasks are no longer processed by Pueue and will not run until restored.
You cannot stash a task that is currently running; it must be stopped or killed first.
Stashed tasks retain their full state and definition, enabling seamless restoration with pueue restore.

Stashed tasks are conceptually moved to a 'holding area' within Pueue. They are not deleted and can be viewed using pueue status --stashed or restored to the active queue.

To bring stashed tasks back into the active queue for processing, use the pueue restore command. You can specify their IDs or use the --all flag to restore all stashed tasks.

Pueue is a modern, cross-platform task queue and command runner written in Rust, known for its simplicity and reliability in managing background jobs. The stash functionality was introduced as a core feature to provide flexibility in task management, allowing users to temporarily shelve tasks without losing their context. It evolved alongside the pueue project to cater to common task management needs, enhancing the overall utility of the system for developers and system administrators.

pueue(1), pueue add(1), pueue restore(1), pueue remove(1), pueue status(1)