|
| 1 | +# reeln queue |
| 2 | + |
| 3 | +Render queue management for staged render-then-publish workflows. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The render queue decouples rendering from publishing. Instead of `POST_RENDER` |
| 8 | +plugin hooks firing immediately after a render, the `--queue` flag on |
| 9 | +`render short` or `render apply` saves the rendered output to a queue for |
| 10 | +review. You can then edit metadata (title, description), selectively publish |
| 11 | +to specific platforms, and track per-target publish status. |
| 12 | + |
| 13 | +Queue files are stored per-game as `render_queue.json` alongside `game.json`. |
| 14 | + |
| 15 | +## Commands |
| 16 | + |
| 17 | +### `reeln queue list` |
| 18 | + |
| 19 | +List queued render items. |
| 20 | + |
| 21 | +```bash |
| 22 | +reeln queue list [OPTIONS] |
| 23 | +``` |
| 24 | + |
| 25 | +| Option | Description | |
| 26 | +|---|---| |
| 27 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 28 | +| `--all`, `-a` | List across all games (uses central index) | |
| 29 | +| `--status`, `-s` | Filter by status: rendered, published, partial, failed | |
| 30 | + |
| 31 | +Removed items are hidden by default. |
| 32 | + |
| 33 | +### `reeln queue show` |
| 34 | + |
| 35 | +Show detailed info for a queue item. |
| 36 | + |
| 37 | +```bash |
| 38 | +reeln queue show <ID> [OPTIONS] |
| 39 | +``` |
| 40 | + |
| 41 | +| Option | Description | |
| 42 | +|---|---| |
| 43 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 44 | + |
| 45 | +Displays output path, duration, file size, game context, player info, render |
| 46 | +profile, publish targets with status and URLs. |
| 47 | + |
| 48 | +ID supports prefix matching (e.g., `abc` matches `abc123def456`). |
| 49 | + |
| 50 | +### `reeln queue edit` |
| 51 | + |
| 52 | +Edit title or description before publishing. |
| 53 | + |
| 54 | +```bash |
| 55 | +reeln queue edit <ID> [OPTIONS] |
| 56 | +``` |
| 57 | + |
| 58 | +| Option | Description | |
| 59 | +|---|---| |
| 60 | +| `--title`, `-t` | New title | |
| 61 | +| `--description`, `-d` | New description | |
| 62 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 63 | + |
| 64 | +At least one of `--title` or `--description` is required. |
| 65 | + |
| 66 | +### `reeln queue publish` |
| 67 | + |
| 68 | +Publish a queue item to one or all targets. |
| 69 | + |
| 70 | +```bash |
| 71 | +reeln queue publish <ID> [OPTIONS] |
| 72 | +``` |
| 73 | + |
| 74 | +| Option | Description | |
| 75 | +|---|---| |
| 76 | +| `--target`, `-t` | Publish to specific target only (e.g., `google`, `meta`) | |
| 77 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 78 | +| `--profile` | Override config profile (default: profile stored at queue time) | |
| 79 | +| `--config` | Explicit config file path | |
| 80 | + |
| 81 | +Without `--target`, publishes to all pending targets. Each target is tracked |
| 82 | +independently — you can publish to YouTube first, review, then push to |
| 83 | +Instagram later. |
| 84 | + |
| 85 | +The config profile stored in the queue item is used by default, ensuring the |
| 86 | +same plugin settings (API keys, channel IDs, etc.) apply. Use `--profile` to |
| 87 | +override. |
| 88 | + |
| 89 | +### `reeln queue publish-all` |
| 90 | + |
| 91 | +Publish all rendered items in the queue. |
| 92 | + |
| 93 | +```bash |
| 94 | +reeln queue publish-all [OPTIONS] |
| 95 | +``` |
| 96 | + |
| 97 | +| Option | Description | |
| 98 | +|---|---| |
| 99 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 100 | +| `--profile` | Named config profile | |
| 101 | +| `--config` | Explicit config file path | |
| 102 | + |
| 103 | +Only items with status `rendered` are published. Items already published, |
| 104 | +failed, or removed are skipped. |
| 105 | + |
| 106 | +### `reeln queue remove` |
| 107 | + |
| 108 | +Soft-delete a queue item. |
| 109 | + |
| 110 | +```bash |
| 111 | +reeln queue remove <ID> [OPTIONS] |
| 112 | +``` |
| 113 | + |
| 114 | +| Option | Description | |
| 115 | +|---|---| |
| 116 | +| `--game-dir`, `-g` | Game directory (default: cwd) | |
| 117 | + |
| 118 | +Marks the item as removed. Does not delete the rendered file. |
| 119 | + |
| 120 | +### `reeln queue targets` |
| 121 | + |
| 122 | +List available publish targets from loaded uploader plugins. |
| 123 | + |
| 124 | +```bash |
| 125 | +reeln queue targets [OPTIONS] |
| 126 | +``` |
| 127 | + |
| 128 | +| Option | Description | |
| 129 | +|---|---| |
| 130 | +| `--profile` | Named config profile | |
| 131 | +| `--config` | Explicit config file path | |
| 132 | + |
| 133 | +Targets are discovered from installed plugins that implement the `Uploader` |
| 134 | +capability protocol. |
| 135 | + |
| 136 | +## Status lifecycle |
| 137 | + |
| 138 | +Queue items progress through these statuses: |
| 139 | + |
| 140 | +| Status | Meaning | |
| 141 | +|---|---| |
| 142 | +| `rendered` | Render complete, not yet published | |
| 143 | +| `publishing` | Publish in progress | |
| 144 | +| `published` | All targets published successfully | |
| 145 | +| `partial` | Some targets published, others pending or failed | |
| 146 | +| `failed` | All target publishes failed | |
| 147 | +| `removed` | Soft-deleted | |
| 148 | + |
| 149 | +Each publish target has its own status: `pending`, `published`, `failed`, or |
| 150 | +`skipped`. |
| 151 | + |
| 152 | +## Examples |
| 153 | + |
| 154 | +```bash |
| 155 | +# Render and queue |
| 156 | +reeln render short clip.mkv --queue --profile tournament-stream |
| 157 | + |
| 158 | +# Review what's queued |
| 159 | +reeln queue list |
| 160 | +reeln queue show abc123 |
| 161 | + |
| 162 | +# Fix the title |
| 163 | +reeln queue edit abc123 --title "Smith Goal - North vs South" |
| 164 | + |
| 165 | +# Publish to YouTube first |
| 166 | +reeln queue publish abc123 --target google |
| 167 | + |
| 168 | +# Review the YouTube upload, then push to Instagram |
| 169 | +reeln queue publish abc123 --target meta |
| 170 | + |
| 171 | +# See all available targets |
| 172 | +reeln queue targets |
| 173 | +``` |
0 commit comments