Deployed af17bad with MkDocs version: 1.6.1

This commit is contained in:
2026-10-01 18:24:26 +00:00
parent 7bad3da697
commit 6f00e6a114
12 changed files with 534 additions and 271 deletions
+5 -4
View File
@@ -2273,19 +2273,20 @@
<hr />
<h2 id="before-you-begin">Before you begin<a class="headerlink" href="#before-you-begin" title="Permanent link">&para;</a></h2>
<p>You need a working unshackle install with services and CDM devices already configured, exactly as you would for a normal command-line download. If <code>unshackle dl</code> works for you, the API will too, since it runs the identical download pipeline.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Installed as a tool</label><label for="__tabbed_1_2">From a clone</label></div>
<p>If you have no install yet, follow <a href="../../../getting-started/installation/">Installation</a>. Then check your tools:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">From a clone</label><label for="__tabbed_1_2">Installed as a uv tool</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>unshackle<span class="w"> </span>--help
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>--help
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
</div>
</div>
</div>
<p>This page uses the bare <code>unshackle</code> command. From a git clone, the recommended install, run each command as <code>uv run unshackle ...</code>.</p>
<hr />
<h2 id="step-1-configure-an-api-secret">Step 1: Configure an API secret<a class="headerlink" href="#step-1-configure-an-api-secret" title="Permanent link">&para;</a></h2>
<p>The server authenticates every request (except the health check) with an API key that you send in the <code>X-Secret-Key</code> header. The server reads this API key from the <code>serve</code> section of your <code>unshackle.yaml</code> config.</p>
+13 -4
View File
@@ -2215,12 +2215,12 @@
<tr>
<td>1</td>
<td>The unshackle package folder</td>
<td><code>.../site-packages/unshackle/unshackle.yaml</code></td>
<td><code>&lt;clone&gt;/unshackle/unshackle.yaml</code> (a <code>uv</code> tool install: <code>.../site-packages/unshackle/unshackle.yaml</code>)</td>
</tr>
<tr>
<td>2</td>
<td>The parent of the package folder</td>
<td><code>.../site-packages/unshackle.yaml</code></td>
<td><code>&lt;clone&gt;/unshackle.yaml</code> (a <code>uv</code> tool install: <code>.../site-packages/unshackle.yaml</code>)</td>
</tr>
<tr>
<td>3</td>
@@ -2229,7 +2229,12 @@
</tr>
</tbody>
</table>
<p>The third location, your per-user config directory, is the recommended place for most installations, because it lives outside the package and survives reinstalls and upgrades. Its exact path depends on your operating system:</p>
<p>Where the file belongs depends on how you installed unshackle:</p>
<ul>
<li><strong>Git clone (recommended).</strong> Keep the file at <code>unshackle/unshackle.yaml</code> inside the clone, which is location 1. <a href="../installation/#what-unshackle-setup-does"><code>unshackle setup</code></a> writes a new config there, and it stays with the clone when you update it.</li>
<li><strong><code>uv</code> tool install.</strong> Use location 3, your per-user config directory. A <code>uv</code> tool upgrade replaces the package folder, so a file at location 1 or 2 is lost. <code>unshackle setup</code> writes a new config there.</li>
</ul>
<p>The path of the per-user config directory depends on your operating system:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Linux</label><label for="__tabbed_1_2">Windows</label><label for="__tabbed_1_3">macOS</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
@@ -2482,7 +2487,11 @@ and every available config key.</p>
<p><strong>Show everything</strong> currently set with <code>--list</code>:</p>
<div class="language-console highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="gp">$ </span>unshackle<span class="w"> </span>cfg<span class="w"> </span>--list
</span></code></pre></div>
<p>When it writes, <code>unshackle cfg</code> targets the config file that unshackle loaded. If none exists yet, it makes <code>unshackle.yaml</code> inside the <code>unshackle</code> package folder (location 1 above), not your OS user-config directory. To keep the config outside the package, make the file at the user-config path yourself first, then <code>unshackle cfg</code> writes to it.</p>
<p>When it writes, <code>unshackle cfg</code> targets the config file that unshackle loaded. If none exists yet, it makes <code>unshackle.yaml</code> in the <code>unshackle</code> package folder (location 1 above):</p>
<ul>
<li><strong>Git clone.</strong> That is <code>unshackle/unshackle.yaml</code> in the clone, which is the correct place.</li>
<li><strong><code>uv</code> tool install.</strong> A tool upgrade replaces the package folder and deletes that file. Run <code>unshackle setup</code> first, which writes the config to your user config directory, or make the file there yourself. Then <code>unshackle cfg</code> writes to it.</li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Editing with <code>cfg</code> strips comments</p>
<p>Because <code>unshackle cfg</code> rewrites the whole file when it saves, a write removes any comments in <code>unshackle.yaml</code>. If you keep important notes as comments, edit the file by hand instead, or keep those notes elsewhere.</p>
+310 -78
View File
@@ -570,6 +570,45 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#install-from-a-git-clone-recommended" class="md-nav__link">
<span class="md-ellipsis">
Install from a git clone (recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-unshackle-setup-does" class="md-nav__link">
<span class="md-ellipsis">
What unshackle setup does
</span>
</a>
<nav class="md-nav" aria-label="What unshackle setup does">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#where-setup-puts-files" class="md-nav__link">
<span class="md-ellipsis">
Where setup puts files
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#requirements-at-a-glance" class="md-nav__link">
<span class="md-ellipsis">
@@ -593,15 +632,15 @@
</li>
<li class="md-nav__item">
<a href="#installing-with-uv" class="md-nav__link">
<a href="#installing-by-hand" class="md-nav__link">
<span class="md-ellipsis">
Installing with uv
Installing by hand
</span>
</a>
<nav class="md-nav" aria-label="Installing with uv">
<nav class="md-nav" aria-label="Installing by hand">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -613,6 +652,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-install-as-a-uv-tool" class="md-nav__link">
<span class="md-ellipsis">
Advanced: install as a uv tool
</span>
</a>
</li>
</ul>
@@ -671,17 +721,6 @@
<nav class="md-nav" aria-label="Verifying your installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#make-sure-the-command-is-available" class="md-nav__link">
<span class="md-ellipsis">
Make sure the command is available
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examine-the-external-dependencies" class="md-nav__link">
<span class="md-ellipsis">
@@ -2112,6 +2151,45 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#install-from-a-git-clone-recommended" class="md-nav__link">
<span class="md-ellipsis">
Install from a git clone (recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-unshackle-setup-does" class="md-nav__link">
<span class="md-ellipsis">
What unshackle setup does
</span>
</a>
<nav class="md-nav" aria-label="What unshackle setup does">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#where-setup-puts-files" class="md-nav__link">
<span class="md-ellipsis">
Where setup puts files
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#requirements-at-a-glance" class="md-nav__link">
<span class="md-ellipsis">
@@ -2135,15 +2213,15 @@
</li>
<li class="md-nav__item">
<a href="#installing-with-uv" class="md-nav__link">
<a href="#installing-by-hand" class="md-nav__link">
<span class="md-ellipsis">
Installing with uv
Installing by hand
</span>
</a>
<nav class="md-nav" aria-label="Installing with uv">
<nav class="md-nav" aria-label="Installing by hand">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -2155,6 +2233,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-install-as-a-uv-tool" class="md-nav__link">
<span class="md-ellipsis">
Advanced: install as a uv tool
</span>
</a>
</li>
</ul>
@@ -2213,17 +2302,6 @@
<nav class="md-nav" aria-label="Verifying your installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#make-sure-the-command-is-available" class="md-nav__link">
<span class="md-ellipsis">
Make sure the command is available
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examine-the-external-dependencies" class="md-nav__link">
<span class="md-ellipsis">
@@ -2285,15 +2363,151 @@
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h1>
<p>unshackle is a modular archival tool for movies, TV, and music. It ships as a
single Python package named <code>unshackle</code> that installs one console command, also
called <code>unshackle</code>. This page covers installing that command, the Python
version it needs, and the external command-line tools it expects to find on your
<code>PATH</code>.</p>
called <code>unshackle</code>. This page covers the install script, the <code>unshackle setup</code>
command, the Python version unshackle needs, and the external command-line tools
it expects to find.</p>
<div class="admonition note">
<p class="admonition-title">What you get</p>
<p>Installing the package registers a single entry point, the <code>unshackle</code>
command. It covers everything: downloading, key-vault management, device
provisioning, the REST server, and the helper utilities.</p>
</div>
<h2 id="install-from-a-git-clone-recommended">Install from a git clone (recommended)<a class="headerlink" href="#install-from-a-git-clone-recommended" title="Permanent link">&para;</a></h2>
<p>A git clone with the install script is the recommended way to install unshackle.
A clone keeps unshackle, its external tools, its config, its data folders, and
your services together in one folder that you can see.</p>
<p>The repository has an install script for Linux (<code>install.sh</code>) and for Windows
(<code>install.bat</code>). The script installs <code>uv</code> if it is not found, installs unshackle,
and then runs <a href="#what-unshackle-setup-does"><code>unshackle setup</code></a>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Linux</label><label for="__tabbed_1_2">Windows</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>unshackle
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>sh<span class="w"> </span>install.sh
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-bat highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git clone https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="k">cd</span> unshackle
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>.\install.bat
</span></code></pre></div>
</div>
</div>
</div>
<p>In a clone, the script runs <code>uv sync</code> and then <code>uv run unshackle setup</code>. The last
lines of setup tell you to check your tools with <code>uv run unshackle env check</code>.
Run unshackle from the clone with <code>uv run unshackle ...</code>.</p>
<p>To install without a clone, see
<a href="#advanced-install-as-a-uv-tool">Advanced: install as a uv tool</a>.</p>
<h2 id="what-unshackle-setup-does">What <code>unshackle setup</code> does<a class="headerlink" href="#what-unshackle-setup-does" title="Permanent link">&para;</a></h2>
<p><code>unshackle setup</code> prepares a new installation. The install script runs it for
you, and you can run it yourself at any time:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">From a clone</label><label for="__tabbed_2_2">Installed as a uv tool</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>setup
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>unshackle<span class="w"> </span>setup
</span></code></pre></div>
</div>
</div>
</div>
<p>The command does these steps:</p>
<ol>
<li>It shows which <a href="#external-tools-on-your-path">external tools</a> are missing,
and where to get the ones that it cannot download.</li>
<li>It asks once for each tool or group of tools to download. The required
tools come first. shaka-packager and <code>mp4decrypt</code> share one DRM question, so
<code>mp4decrypt</code> comes with the required tools, but <code>env check</code> still shows it
as optional. The HDR and subtitle groups are optional. The prompts show the
version that setup downloads. On Windows, the subtitle question also shows
the download size of CCExtractor, which is much larger than the other tools.
It puts the downloads in a <code>binaries</code> folder
(see <a href="#where-setup-puts-files">Where setup puts files</a>).</li>
<li>If no <code>unshackle.yaml</code> exists, it asks for a downloads folder and writes a
minimal config file.</li>
<li>It makes the data folders for cookies, WVDs, PRDs, and services.</li>
<li>It asks for <code>.wvd</code> and <code>.prd</code> devices to import. You can give a file or a
folder of devices, and it asks again until you give an empty answer. It
validates each file, copies it into the WVDs or PRDs folder, and prints one
line for each file. If setup wrote a new config in this run, it sets
<code>cdm.default</code> to the imported device. If you imported more than one, it
asks which one is the default.</li>
<li>It prints a summary of the tools that it found. If it wrote a config, it
gives the path of that config and a link to the
<a href="../../reference/configuration/">configuration reference</a>. Then it
tells you to run <code>env check</code> next.</li>
</ol>
<p>You can run the command again. It skips the tools that it finds and never
overwrites an existing config.</p>
<div class="admonition note">
<p class="admonition-title">Not every tool has a download</p>
<p>Setup downloads tools only on Linux and Windows, and only when the tool
has a portable build for your system. For other tools, setup prints where
to get them, for example a package manager. On macOS, setup downloads
nothing and prints these links for each missing tool.</p>
<p>On Linux, setup cannot download MKVToolNix, which is a required tool.
Install the <code>mkvtoolnix</code> package with your package manager (for example
<code>apt</code>, <code>dnf</code>, or <code>pacman</code>).</p>
</div>
<div class="admonition warning">
<p class="admonition-title">CCExtractor on Linux needs FUSE</p>
<p>On Linux, setup downloads CCExtractor as an AppImage, which needs FUSE to
run. Setup runs the AppImage once after the download. If it does not run, setup removes it and prints the
manual install link. Install FUSE with your package manager and run setup
again, or install the <code>ccextractor</code> package instead.</p>
</div>
<h3 id="where-setup-puts-files">Where setup puts files<a class="headerlink" href="#where-setup-puts-files" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Item</th>
<th>From a git clone</th>
<th>From a <code>uv</code> tool install</th>
</tr>
</thead>
<tbody>
<tr>
<td>External tools</td>
<td><code>unshackle/binaries</code> in the clone</td>
<td><code>binaries</code> in the user data directory</td>
</tr>
<tr>
<td>New config (<code>unshackle.yaml</code>)</td>
<td><code>unshackle/unshackle.yaml</code> in the clone</td>
<td>The user config directory</td>
</tr>
<tr>
<td>Data folders (cookies, WVDs, PRDs, cache, logs, services, temp)</td>
<td>The default folders in the clone</td>
<td>The user data directory</td>
</tr>
<tr>
<td>Downloads</td>
<td>The folder that you give at the prompt</td>
<td>The folder that you give at the prompt</td>
</tr>
</tbody>
</table>
<p>On Windows, CCExtractor and its libraries go into their own <code>ccextractor</code>
subfolder of the tools folder.</p>
<p>On Linux, the user data directory is usually <code>~/.local/share/unshackle</code> and the
user config directory is usually <code>~/.config/unshackle</code>. On Windows, both are
<code>%LOCALAPPDATA%\unshackle</code>. Run <code>uv run unshackle env info</code> to see the paths that
unshackle uses. Its <code>User_Binaries</code> row shows the <code>binaries</code> folder in the user
data directory.</p>
<p>Setup writes a new config only when it finds no <code>unshackle.yaml</code> in any of the
<a href="../configuration-file/">config locations</a>. It keeps an existing config where it
is. In a clone, the new config sets only <code>directories.downloads</code>, so the data
folders stay at their defaults in the clone.</p>
<p>A <code>uv</code> tool upgrade replaces the package folder. For a <code>uv</code> tool install, setup
puts the tools in the user data directory and writes a <code>directories</code> block that
moves the data folders there, so an upgrade keeps them. If an existing config
keeps data folders inside the package of a <code>uv</code> tool install, setup shows a
warning and prints the <code>directories</code> lines to add.</p>
<h2 id="requirements-at-a-glance">Requirements at a glance<a class="headerlink" href="#requirements-at-a-glance" title="Permanent link">&para;</a></h2>
<table>
<thead>
@@ -2355,34 +2569,50 @@ later is unsupported, and the installer refuses to assemble the environment.</p>
<p>You do not usually need to install a matching Python interpreter by hand, since
<code>uv</code> can download and manage one for you. If you work inside an existing
virtual environment, make sure that it is on a supported version.</p>
<h2 id="installing-with-uv">Installing with uv<a class="headerlink" href="#installing-with-uv" title="Permanent link">&para;</a></h2>
<p>The recommended way to install unshackle is as a <code>uv</code> tool. This creates an
isolated environment for the package and puts the <code>unshackle</code> command on your
<code>PATH</code> without touching your system Python.</p>
<div class="language-shell highlight"><span class="filename">Install as a uv tool</span><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/unshackle-dl/unshackle.git
<h2 id="installing-by-hand">Installing by hand<a class="headerlink" href="#installing-by-hand" title="Permanent link">&para;</a></h2>
<p>If you do not use the install script, install unshackle with <code>uv</code> and then run
<code>unshackle setup</code>, or install the <a href="#external-tools-on-your-path">external tools</a>
yourself.</p>
<h3 id="running-from-a-clone">Running from a clone<a class="headerlink" href="#running-from-a-clone" title="Permanent link">&para;</a></h3>
<p>Use <code>uv run</code> inside the clone. It keeps the project's virtual environment active
for the duration of the command, so you do not have to activate it yourself. It
also installs the dependencies on the first run.</p>
<div class="language-shell highlight"><span class="filename">Run from a git clone</span><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nb">cd</span><span class="w"> </span>unshackle
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>setup
</span></code></pre></div>
<p>Once it finishes, the <code>unshackle</code> command is available globally:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>unshackle<span class="w"> </span>--help
<p>Every command shown elsewhere in these docs works the same way from a clone.
Prefix it with <code>uv run</code>:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
<h3 id="advanced-install-as-a-uv-tool">Advanced: install as a uv tool<a class="headerlink" href="#advanced-install-as-a-uv-tool" title="Permanent link">&para;</a></h3>
<p>This way is for users who know <code>uv</code> tools and want the <code>unshackle</code> command on
their <code>PATH</code> without a clone.</p>
<div class="admonition note">
<p class="admonition-title">Where a uv tool install keeps files</p>
<p><code>uv tool install</code> puts unshackle into the tool folder of <code>uv</code>, not into a
folder that you choose. <code>unshackle setup</code> therefore puts the external
tools, the config, and the data folders in your user data and config
directories (see <a href="#where-setup-puts-files">Where setup puts files</a>). A git
clone is the easier setup: its tools, config, data, and services stay in
one folder that you can see. On the first run from a <code>uv</code> tool install,
<code>unshackle setup</code> tells you this and asks if you want to continue.</p>
</div>
<p>Install the tool and run setup:</p>
<div class="language-shell highlight"><span class="filename">Install as a uv tool</span><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>unshackle<span class="w"> </span>setup
</span></code></pre></div>
<p>The install scripts also do this when you run one alone, without a clone: when
the script does not find the unshackle <code>pyproject.toml</code> next to it, it runs
<code>uv tool install</code> and then <code>unshackle setup</code>. When it finishes, it tells you to
open a new terminal, because the <code>PATH</code> change only applies to new terminals.
Run <code>unshackle env check</code> there.</p>
<div class="admonition tip">
<p class="admonition-title">Upgrading and removing</p>
<p>Because you installed it from a git URL, re-run the same
<code>uv tool install</code> command (uv will update in place) to get a newer version,
and use <code>uv tool uninstall unshackle</code> to remove it.</p>
</div>
<h3 id="running-from-a-clone">Running from a clone<a class="headerlink" href="#running-from-a-clone" title="Permanent link">&para;</a></h3>
<p>If you would rather work from a checkout of the repository (for example to try
an in-development branch or to keep your own local services alongside unshackle), use
<code>uv run</code> inside the clone. This keeps the project's virtual environment active
for the duration of the command, so you do not have to activate it yourself.</p>
<div class="language-shell highlight"><span class="filename">Run from a git clone</span><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nb">cd</span><span class="w"> </span>unshackle
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>--help
</span></code></pre></div>
<p>Every command shown elsewhere in these docs works the same way from a clone.
Prefix it with <code>uv run</code>:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
<div class="admonition note">
<p class="admonition-title">Developer note</p>
<p>Contributors will also want the development and test dependency groups. The
@@ -2394,9 +2624,12 @@ these entirely.</p>
<h2 id="external-tools-on-your-path">External tools on your PATH<a class="headerlink" href="#external-tools-on-your-path" title="Permanent link">&para;</a></h2>
<p>unshackle shells out to a number of external command-line programs for media
processing and DRM work. It looks for each one first in the <code>binaries/</code> folder
inside the installed package, and then falls back to your system <code>PATH</code>, so
installing these tools system-wide (or dropping them into that folder) both
work.</p>
inside the installed package, then in the <code>binaries</code> folder of your user data
directory, and then on your system <code>PATH</code>. <code>unshackle setup</code> installs tools into
the first folder in a clone and into the second for a <code>uv</code> tool install. Installing a tool system-wide or putting it into one of those folders
both work.</p>
<p><code>unshackle setup</code> installs the required tools and some optional ones for you.
Use the tables below when you install a tool by hand.</p>
<h3 id="required-tools">Required tools<a class="headerlink" href="#required-tools" title="Permanent link">&para;</a></h3>
<p>These must be present for core downloading, decryption, and muxing to work:</p>
<table>
@@ -2487,7 +2720,7 @@ download. For example, <code>dovi_tool</code> only matters if you download Dolby
</tr>
<tr>
<td>CCExtractor</td>
<td><code>ccextractor</code></td>
<td><code>ccextractor</code>, <code>ccextractorwin</code>, <code>ccextractorwinfull</code></td>
<td>Extracting closed captions</td>
</tr>
<tr>
@@ -2535,47 +2768,46 @@ SubtitleEdit 5.x, before falling back to a <code>SubtitleEdit</code> (4.x) binar
automated subtitle conversion.</p>
</div>
<h2 id="verifying-your-installation">Verifying your installation<a class="headerlink" href="#verifying-your-installation" title="Permanent link">&para;</a></h2>
<p>After installation, make sure that the command works and that unshackle can see
the tools it depends on.</p>
<h3 id="make-sure-the-command-is-available">Make sure the command is available<a class="headerlink" href="#make-sure-the-command-is-available" title="Permanent link">&para;</a></h3>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>unshackle<span class="w"> </span>--help
</span></code></pre></div>
<p>This prints the list of available commands (<code>dl</code>, <code>env</code>, <code>kv</code>,
<code>serve</code>, <code>wvd</code>, <code>prd</code>, <code>search</code>, <code>util</code>, <code>cfg</code>, <code>import</code>). If your shell reports
that <code>unshackle</code> is not found, the <code>uv tool</code> bin directory is probably not on
your <code>PATH</code>. Operate <code>uv tool update-shell</code> and open a new terminal.</p>
<p>After installation, make sure that unshackle can see the tools it depends on.</p>
<h3 id="examine-the-external-dependencies">Examine the external dependencies<a class="headerlink" href="#examine-the-external-dependencies" title="Permanent link">&para;</a></h3>
<p>The <code>env check</code> subcommand inspects your environment and reports which tools it
found:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Output</label><label for="__tabbed_1_2">From a clone</label></div>
<p>The <code>env check</code> subcommand is the first check. It inspects your environment and
reports which tools it found:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="__tabbed_3_1">From a clone</label><label for="__tabbed_3_2">Installed as a uv tool</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>It prints a table grouped by category (Core, DRM, HDR, Subtitle, Player,
Network) with a status column: a green check for tools that resolved and a
red cross for those it could not find, plus a summary line such as
<code>All required tools installed ✓</code> or <code>Missing required: &lt;names&gt;</code>.</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
<div class="language-shell highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
</div>
</div>
</div>
<p>If a required tool shows as missing, install it and put it on your <code>PATH</code> (or in
the package's <code>binaries/</code> folder), then re-run the check.</p>
<p>It prints a table grouped by category (Core, DRM, HDR, Subtitle, Player,
Network) with a status column: a green check for tools that resolved and a red
cross for those it could not find, plus a summary line such as
<code>All required tools installed ✓</code> or <code>Missing required: &lt;names&gt;</code>.</p>
<p>If a required tool shows as missing, <code>env check</code> tells you to run
<code>unshackle setup</code>. You can also install the tool by hand and put it on your
<code>PATH</code> (or in one of the <code>binaries</code> folders), then re-run the check.</p>
<div class="admonition tip">
<p class="admonition-title"><code>unshackle</code> is not found after a uv tool install</p>
<p>The bin directory of <code>uv</code> tools is probably not on your <code>PATH</code>. Run
<code>uv tool update-shell</code> and open a new terminal.</p>
</div>
<h3 id="inspect-environment-paths">Inspect environment paths<a class="headerlink" href="#inspect-environment-paths" title="Permanent link">&para;</a></h3>
<p>To see where unshackle will read its configuration from and where it stores
downloads, caches, cookies, and devices, use:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>info
<div class="language-shell highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>info
</span></code></pre></div>
<p>If no configuration file exists yet, this command lists the locations unshackle
searches for one, so you know where to make it. See the
<a href="../configuration-file/">configuration guide</a> for the details of that file.</p>
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<ul>
<li>Set up your <a href="../configuration-file/">configuration</a> file (<code>unshackle.yaml</code>).</li>
<li>Set up your <a href="../configuration-file/">configuration</a> file (<code>unshackle.yaml</code>), or
let <code>unshackle setup</code> write a first one.</li>
<li>Start <a href="../../guide/downloading/">downloading</a> titles when <code>env check</code> finds every required tool.</li>
</ul>
+44 -78
View File
@@ -599,10 +599,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1-examine-your-environment" class="md-nav__link">
<a href="#1-run-setup" class="md-nav__link">
<span class="md-ellipsis">
1. Examine your environment
1. Run setup
</span>
</a>
@@ -610,31 +610,14 @@
</li>
<li class="md-nav__item">
<a href="#2-make-a-minimal-config" class="md-nav__link">
<a href="#2-check-the-output-template" class="md-nav__link">
<span class="md-ellipsis">
2. Make a minimal config
2. Check the output template
</span>
</a>
<nav class="md-nav" aria-label="2. Make a minimal config">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#the-one-config-key-you-must-set" class="md-nav__link">
<span class="md-ellipsis">
The one config key you must set
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2096,10 +2079,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1-examine-your-environment" class="md-nav__link">
<a href="#1-run-setup" class="md-nav__link">
<span class="md-ellipsis">
1. Examine your environment
1. Run setup
</span>
</a>
@@ -2107,31 +2090,14 @@
</li>
<li class="md-nav__item">
<a href="#2-make-a-minimal-config" class="md-nav__link">
<a href="#2-check-the-output-template" class="md-nav__link">
<span class="md-ellipsis">
2. Make a minimal config
2. Check the output template
</span>
</a>
<nav class="md-nav" aria-label="2. Make a minimal config">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#the-one-config-key-you-must-set" class="md-nav__link">
<span class="md-ellipsis">
The one config key you must set
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2255,9 +2221,10 @@ module and CDM it needs to fetch and decrypt media, operate a basic <code>unshac
command, and learn where the finished file lands.</p>
<div class="admonition note">
<p class="admonition-title">Before you start</p>
<p>This guide assumes unshackle is already installed and on your <code>PATH</code>. If
<code>unshackle --help</code> does not print a help screen, work through
<a href="../installation/">Installation</a> first.</p>
<p>This guide assumes that you installed unshackle as
<a href="../installation/">Installation</a> describes. The examples use the bare
<code>unshackle</code> command. From a git clone, the recommended install, run each
one as <code>uv run unshackle ...</code>, for example <code>uv run unshackle env check</code>.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">unshackle includes no services</p>
@@ -2266,42 +2233,38 @@ module for any streaming platform, so you write that part yourself
(<a href="#3-write-a-service">step 3</a>). <code>EXAMPLE</code> in this guide stands in for the tag you
give yours.</p>
</div>
<h2 id="1-examine-your-environment">1. Examine your environment<a class="headerlink" href="#1-examine-your-environment" title="Permanent link">&para;</a></h2>
<h2 id="1-run-setup">1. Run setup<a class="headerlink" href="#1-run-setup" title="Permanent link">&para;</a></h2>
<p>unshackle drives several external tools (FFmpeg, MKVToolNix, shaka-packager, and
others) to decrypt, repack, and mux media. Make sure that they are visible before
you download anything:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
others) to decrypt, repack, and mux media, and it needs a config file. The
<code>unshackle setup</code> command prepares both. If you used the install script, setup
has already run. You can run it again at any time:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>unshackle<span class="w"> </span>setup
</span></code></pre></div>
<p>This prints a dependency table. The <strong>required</strong> tools (FFmpeg, FFprobe,
MKVToolNix, mkvpropedit, and shaka-packager) must show a green check. Optional
tools such as <code>dovi_tool</code> (Dolby Vision) and CCExtractor (closed captions) only
matter for the features that use them.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The summary line at the bottom reports <code>installed/total</code> and lists anything
required that is still missing, so you know exactly what to install next.</p>
<p>Setup downloads the missing required tools and, if you agree, groups of optional
tools. If no <code>unshackle.yaml</code> exists, it writes a minimal one with your downloads
folder. It also makes the data folders and lets you import <code>.wvd</code> and <code>.prd</code>
devices, one file or a whole folder at a time. <a href="../installation/#what-unshackle-setup-does">Installation</a> tells you what
each step does and where the files go.</p>
<p>Then make sure that unshackle finds the tools:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
<p>The <strong>required</strong> tools (FFmpeg, FFprobe, MKVToolNix, mkvpropedit, and
shaka-packager) must show a green check. Optional tools such as <code>dovi_tool</code>
(Dolby Vision) and CCExtractor (closed captions) only matter for the features
that use them.</p>
<div class="admonition note">
<p class="admonition-title">Set up by hand</p>
<p>To do these steps yourself, install the tools from the tables in
<a href="../installation/#external-tools-on-your-path">Installation</a>. Then run
<code>unshackle env info</code> to see where unshackle looks for <code>unshackle.yaml</code>, and
make the file in one of those locations. The
<a href="../configuration-file/">configuration guide</a> gives the details.</p>
</div>
<h2 id="2-make-a-minimal-config">2. Make a minimal config<a class="headerlink" href="#2-make-a-minimal-config" title="Permanent link">&para;</a></h2>
<p>unshackle reads a single configuration file named <code>unshackle.yaml</code>. To see where it
looks for that file, and where it <em>would</em> accept one if you have not made it yet,
use this command:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>info
</span></code></pre></div>
<p>If no config exists, this prints the candidate locations. In the order unshackle
examines them, they are:</p>
<ol>
<li><code>unshackle.yaml</code> inside the unshackle package folder.</li>
<li><code>unshackle.yaml</code> in that folder's parent.</li>
<li><code>unshackle.yaml</code> in your OS user-config directory
(<code>~/.config/unshackle/</code> on Linux, <code>%LOCALAPPDATA%\unshackle\</code> on Windows,
<code>~/Library/Application Support/unshackle/</code> on macOS).</li>
</ol>
<p>The <strong>first</strong> file that exists wins. Make <code>unshackle.yaml</code> in one of those
locations.</p>
<h3 id="the-one-config-key-you-must-set">The one config key you must set<a class="headerlink" href="#the-one-config-key-you-must-set" title="Permanent link">&para;</a></h3>
<h2 id="2-check-the-output-template">2. Check the output template<a class="headerlink" href="#2-check-the-output-template" title="Permanent link">&para;</a></h2>
<p>unshackle refuses to start a download unless it knows how to name the output file.
That means <code>output_template</code> is the one setting a first run genuinely requires.
Everything else has a sensible default. A minimal, working config looks like this:</p>
Everything else has a sensible default. The config that setup writes copies <code>tag</code>
and <code>output_template</code> from the example config. A minimal, working config looks like this:</p>
<div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">output_template</span><span class="p">:</span>
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">movies</span><span class="p">:</span><span class="w"> </span><span class="s">"{title}</span><span class="nv"> </span><span class="s">({year})</span><span class="nv"> </span><span class="s">{quality}</span><span class="nv"> </span><span class="s">{source}"</span>
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">series</span><span class="p">:</span><span class="w"> </span><span class="s">"{title}</span><span class="nv"> </span><span class="s">{season_episode}</span><span class="nv"> </span><span class="s">{episode_name?}</span><span class="nv"> </span><span class="s">{quality}</span><span class="nv"> </span><span class="s">{source}"</span>
@@ -2332,7 +2295,9 @@ shows the path). The tag then works with <code>dl</code>, <code>search</code>, a
commands.</p>
<h2 id="4-add-a-cdm-for-drm">4. Add a CDM for DRM<a class="headerlink" href="#4-add-a-cdm-for-drm" title="Permanent link">&para;</a></h2>
<p>Most streaming services encrypt their titles. To fetch content keys, unshackle
needs a <strong>CDM</strong>, a Widevine device (<code>.wvd</code>) or a PlayReady device (<code>.prd</code>). Add a
needs a <strong>CDM</strong>, a Widevine device (<code>.wvd</code>) or a PlayReady device (<code>.prd</code>). If you
imported devices during <code>unshackle setup</code>, they are already in place. If setup also
wrote your config, it set <code>cdm.default</code> to the device that you chose. Otherwise, add a
Widevine device you already have with:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>add<span class="w"> </span>/path/to/device.wvd
</span></code></pre></div>
@@ -2457,7 +2422,8 @@ tags the result.</p>
codec, bitrate, channel-layout, and track-type selection.</p>
<h2 id="8-where-the-output-lands">8. Where the output lands<a class="headerlink" href="#8-where-the-output-lands" title="Permanent link">&para;</a></h2>
<p>By default, unshackle writes finished files to the <code>downloads</code> directory.
<code>unshackle env info</code> shows its exact path. The built-in default is a <code>downloads</code>
<code>unshackle env info</code> shows its exact path. A config from <code>unshackle setup</code> uses the
folder that you gave at its prompt. Without that setting, the default is a <code>downloads</code>
folder one level above the installed <code>unshackle</code> package. Override it for one
command with <code>-o</code>:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-q<span class="w"> </span><span class="m">1080</span><span class="w"> </span>-o<span class="w"> </span>/mnt/media/incoming<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
+94 -55
View File
@@ -923,6 +923,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
<span class="md-ellipsis">
setup
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2580,6 +2591,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
<span class="md-ellipsis">
setup
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2896,12 +2918,17 @@
<li><strong><a href="#dl"><code>dl</code></a></strong>: the download pipeline (the command you use most).</li>
<li><strong><a href="#search"><code>search</code></a></strong>: find titles on a service.</li>
<li><strong><a href="#import"><code>import</code></a></strong>: rebuild a download from an export file.</li>
<li><strong><a href="#setup"><code>setup</code></a></strong>: install the external tools and make a first config.</li>
<li><strong><a href="#cfg"><code>cfg</code></a></strong>, <strong><a href="#env"><code>env</code></a></strong>: manage configuration and the environment.</li>
<li><strong><a href="#kv"><code>kv</code></a></strong>: Key Vault operations.</li>
<li><strong><a href="#wvd"><code>wvd</code></a></strong>, <strong><a href="#prd"><code>prd</code></a></strong>: Widevine / PlayReady device management.</li>
<li><strong><a href="#serve"><code>serve</code></a></strong>: operate the local CDM and REST API server.</li>
<li><strong><a href="#util"><code>util</code></a></strong>: helper media utilities.</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Running commands from a clone</p>
<p>This page uses the bare <code>unshackle</code> command. From a git clone, the recommended install, run each command as <code>uv run unshackle ...</code>.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Getting help on any command</p>
<p>Every command accepts <code>-h</code>, <code>--help</code>, or <code>-?</code>. For example <code>unshackle dl --help</code> or <code>unshackle wvd new --help</code>. Each service defines its own arguments for <code>dl</code> and <code>search</code> (such as a title ID or a query), so examine <code>unshackle dl SERVICE --help</code> for those.</p>
@@ -3496,9 +3523,21 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</div>
<p>The export file can be a <code>mediaexport</code> file from <code>dl --export</code>, an export from an older version of unshackle, or an export from unidl. The file must name the service it came from.</p>
<hr />
<h2 id="setup"><code>setup</code><a class="headerlink" href="#setup" title="Permanent link">&para;</a></h2>
<p>Install the external tools and make a first config.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>unshackle setup
</span></code></pre></div>
<p>The command takes no options and asks its questions at the prompt. It shows the missing <a href="../../getting-started/installation/#external-tools-on-your-path">external tools</a> and downloads the ones you accept. It puts them in a <code>binaries</code> folder, in the package folder of a git clone or in your user data directory for a <code>uv</code> tool install. If no <code>unshackle.yaml</code> exists, it writes a first one: inside the clone, or to your user config directory for a <code>uv</code> tool install. It then makes the data folders and imports <code>.wvd</code> and <code>.prd</code> devices, one file or folder per answer, until you give an empty answer. It ends with a summary of the tools, the path of a config that it wrote, and a pointer to <code>env check</code>. You can run it again: it skips the tools it finds and never overwrites a config. <a href="../../getting-started/installation/#what-unshackle-setup-does">Installation</a> gives the full steps and where each file goes.</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>setup<span class="w"> </span><span class="c1"># from a git clone</span>
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>unshackle<span class="w"> </span>setup<span class="w"> </span><span class="c1"># from a uv tool install</span>
</span></code></pre></div>
</div>
<hr />
<h2 id="cfg"><code>cfg</code><a class="headerlink" href="#cfg" title="Permanent link">&para;</a></h2>
<p>Read, set, delete, or show configuration values in <code>unshackle.yaml</code> without hand-editing YAML.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>unshackle cfg [KEY] [VALUE] [OPTIONS]
<div class="language-text highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>unshackle cfg [KEY] [VALUE] [OPTIONS]
</span></code></pre></div>
<table>
<thead>
@@ -3532,23 +3571,23 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</div>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>--list<span class="w"> </span><span class="c1"># print entire config</span>
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>serve.api_secret<span class="w"> </span><span class="c1"># read a nested key</span>
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>tag<span class="w"> </span>MYGROUP<span class="w"> </span><span class="c1"># set a string</span>
</span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>update_checks<span class="w"> </span><span class="nb">false</span><span class="w"> </span><span class="c1"># literal → boolean False</span>
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>directories.downloads<span class="w"> </span>/mnt/dl<span class="w"> </span><span class="c1"># set a nested path</span>
</span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>tag<span class="w"> </span>--unset<span class="w"> </span><span class="c1"># remove a key</span>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>--list<span class="w"> </span><span class="c1"># print entire config</span>
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>serve.api_secret<span class="w"> </span><span class="c1"># read a nested key</span>
</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>tag<span class="w"> </span>MYGROUP<span class="w"> </span><span class="c1"># set a string</span>
</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>update_checks<span class="w"> </span><span class="nb">false</span><span class="w"> </span><span class="c1"># literal → boolean False</span>
</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>directories.downloads<span class="w"> </span>/mnt/dl<span class="w"> </span><span class="c1"># set a nested path</span>
</span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a>unshackle<span class="w"> </span>cfg<span class="w"> </span>tag<span class="w"> </span>--unset<span class="w"> </span><span class="c1"># remove a key</span>
</span></code></pre></div>
</div>
<hr />
<h2 id="env"><code>env</code><a class="headerlink" href="#env" title="Permanent link">&para;</a></h2>
<p>Inspect and manage the project environment.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>unshackle env COMMAND [ARGS]...
<div class="language-text highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>unshackle env COMMAND [ARGS]...
</span></code></pre></div>
<h3 id="env-check"><code>env check</code><a class="headerlink" href="#env-check" title="Permanent link">&para;</a></h3>
<div class="language-text highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>unshackle env check
<div class="language-text highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>unshackle env check
</span></code></pre></div>
<p>Prints a dependency table (Category / Tool / Status / Required / Purpose) that shows which external tools unshackle finds on your <code>PATH</code>. It also gives a summary of how many required tools are present.</p>
<p>Prints a dependency table (Category / Tool / Status / Required / Purpose) that shows which external tools unshackle finds on your <code>PATH</code>. It also gives a summary of how many required tools are present. If a required tool is missing, it tells you to run <a href="#setup"><code>unshackle setup</code></a>.</p>
<table>
<thead>
<tr>
@@ -3585,11 +3624,11 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</table>
<p><small>* required. All others are optional.</small></p>
<h3 id="env-info"><code>env info</code><a class="headerlink" href="#env-info" title="Permanent link">&para;</a></h3>
<div class="language-text highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>unshackle env info
<div class="language-text highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>unshackle env info
</span></code></pre></div>
<p>Shows the location unshackle loaded the configuration file from. If it found no file, it shows the candidate locations instead. It then prints a table of every configured directory (downloads, temp, cache, cookies, logs, exports, WVDs, PRDs, services, and more).</p>
<h3 id="env-theme"><code>env theme</code><a class="headerlink" href="#env-theme" title="Permanent link">&para;</a></h3>
<div class="language-text highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>unshackle env theme
<div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>unshackle env theme
</span></code></pre></div>
<p>Prints a sample of every available CLI theme. Each sample has colour swatches, help text with option rows, and a track listing with video, audio and subtitle entries. It also has log lines, a progress bar, and the gradient pulse bar. unshackle marks the active theme and shows each theme's aliases. Set your choice with the <a href="../../reference/configuration/misc/#appearance"><code>theme</code></a> config key.</p>
<h3 id="env-clear"><code>env clear</code><a class="headerlink" href="#env-clear" title="Permanent link">&para;</a></h3>
@@ -3614,18 +3653,18 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</table>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>unshackle<span class="w"> </span>env<span class="w"> </span>info
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>unshackle<span class="w"> </span>env<span class="w"> </span>theme
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>cache
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>cache<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="c1"># one service only</span>
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>temp
<div class="language-shell highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>unshackle<span class="w"> </span>env<span class="w"> </span>info
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>unshackle<span class="w"> </span>env<span class="w"> </span>theme
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>cache
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>cache<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="c1"># one service only</span>
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a>unshackle<span class="w"> </span>env<span class="w"> </span>clear<span class="w"> </span>temp
</span></code></pre></div>
</div>
<hr />
<h2 id="kv"><code>kv</code><a class="headerlink" href="#kv" title="Permanent link">&para;</a></h2>
<p>Manage Key Vaults. You configure vaults under <code>key_vaults</code> in <code>unshackle.yaml</code>, each with a <code>name</code>, a <code>type</code> (<code>sqlite</code>, <code>mysql</code>, <code>http</code>, <code>api</code>), and type-specific options. unshackle normalises service tags automatically.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>unshackle kv COMMAND [ARGS]...
<div class="language-text highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>unshackle kv COMMAND [ARGS]...
</span></code></pre></div>
<h3 id="kv-copy-to_vault-from_vault"><code>kv copy TO_VAULT FROM_VAULT...</code><a class="headerlink" href="#kv-copy-to_vault-from_vault" title="Permanent link">&para;</a></h3>
<p>Copy content keys from one or more source vaults into a destination vault. unshackle skips rows whose KIDs match, unless the existing row has no content key. unshackle never alters or deletes existing data.</p>
@@ -3679,18 +3718,18 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
<p>Make service tables on vaults that use tables, for every installed service, where they do not already exist.</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>copy<span class="w"> </span>main<span class="w"> </span>backup1<span class="w"> </span>backup2
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>copy<span class="w"> </span>main<span class="w"> </span>backup<span class="w"> </span>-s<span class="w"> </span>EXAMPLE
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>sync<span class="w"> </span>main<span class="w"> </span>mysql_vault
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>add<span class="w"> </span>keys.txt<span class="w"> </span>EXAMPLE<span class="w"> </span>main<span class="w"> </span>backup
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>search<span class="w"> </span>0123456789abcdef0123456789abcdef<span class="w"> </span>-s<span class="w"> </span>EXAMPLE<span class="w"> </span>-v<span class="w"> </span>main
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>prepare<span class="w"> </span>main<span class="w"> </span>mysql_vault
<div class="language-shell highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>copy<span class="w"> </span>main<span class="w"> </span>backup1<span class="w"> </span>backup2
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>copy<span class="w"> </span>main<span class="w"> </span>backup<span class="w"> </span>-s<span class="w"> </span>EXAMPLE
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>sync<span class="w"> </span>main<span class="w"> </span>mysql_vault
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>add<span class="w"> </span>keys.txt<span class="w"> </span>EXAMPLE<span class="w"> </span>main<span class="w"> </span>backup
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>search<span class="w"> </span>0123456789abcdef0123456789abcdef<span class="w"> </span>-s<span class="w"> </span>EXAMPLE<span class="w"> </span>-v<span class="w"> </span>main
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>unshackle<span class="w"> </span>kv<span class="w"> </span>prepare<span class="w"> </span>main<span class="w"> </span>mysql_vault
</span></code></pre></div>
</div>
<hr />
<h2 id="wvd"><code>wvd</code><a class="headerlink" href="#wvd" title="Permanent link">&para;</a></h2>
<p>Manage Widevine Device (<code>.wvd</code>) files. Devices live in the configured WVDs directory.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>unshackle wvd COMMAND [ARGS]...
<div class="language-text highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>unshackle wvd COMMAND [ARGS]...
</span></code></pre></div>
<table>
<thead>
@@ -3751,16 +3790,16 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</table>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>add<span class="w"> </span>device.wvd
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>parse<span class="w"> </span>nexus_6p_1234_l1
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>dump<span class="w"> </span>device.wvd<span class="w"> </span>./out_dir
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>new<span class="w"> </span><span class="s2">"Nexus 6P"</span><span class="w"> </span>private_key.pem<span class="w"> </span>client_id.bin<span class="w"> </span>vmp.bin<span class="w"> </span>-t<span class="w"> </span>ANDROID<span class="w"> </span>-l<span class="w"> </span><span class="m">3</span>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>add<span class="w"> </span>device.wvd
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>parse<span class="w"> </span>nexus_6p_1234_l1
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>dump<span class="w"> </span>device.wvd<span class="w"> </span>./out_dir
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>unshackle<span class="w"> </span>wvd<span class="w"> </span>new<span class="w"> </span><span class="s2">"Nexus 6P"</span><span class="w"> </span>private_key.pem<span class="w"> </span>client_id.bin<span class="w"> </span>vmp.bin<span class="w"> </span>-t<span class="w"> </span>ANDROID<span class="w"> </span>-l<span class="w"> </span><span class="m">3</span>
</span></code></pre></div>
</div>
<hr />
<h2 id="prd"><code>prd</code><a class="headerlink" href="#prd" title="Permanent link">&para;</a></h2>
<p>Manage PlayReady Device (<code>.prd</code>) files. Devices live in the configured PRDs directory. Built on <code>pyplayready</code>.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>unshackle prd COMMAND [ARGS]...
<div class="language-text highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>unshackle prd COMMAND [ARGS]...
</span></code></pre></div>
<h3 id="prd-new-paths"><code>prd new PATHS...</code><a class="headerlink" href="#prd-new-paths" title="Permanent link">&para;</a></h3>
<p>Make a new <code>.prd</code>. Give either a single folder that contains <code>zgpriv.dat</code> (group key) and <code>bgroupcert.dat</code> (group certificate), or two file paths (group key, then group certificate).</p>
@@ -3814,16 +3853,16 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</table>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>new<span class="w"> </span>./device_folder/
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>new<span class="w"> </span>zgpriv.dat<span class="w"> </span>bgroupcert.dat<span class="w"> </span>-o<span class="w"> </span>/out/dir
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>reprovision<span class="w"> </span>mydevice.prd
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>unshackle<span class="w"> </span>prd<span class="w"> </span><span class="nb">test</span><span class="w"> </span>mydevice.prd<span class="w"> </span>-sl<span class="w"> </span><span class="m">3000</span><span class="w"> </span>-c<span class="w"> </span>aescbc
<div class="language-shell highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>new<span class="w"> </span>./device_folder/
</span><span id="__span-21-2"><a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>new<span class="w"> </span>zgpriv.dat<span class="w"> </span>bgroupcert.dat<span class="w"> </span>-o<span class="w"> </span>/out/dir
</span><span id="__span-21-3"><a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>unshackle<span class="w"> </span>prd<span class="w"> </span>reprovision<span class="w"> </span>mydevice.prd
</span><span id="__span-21-4"><a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a>unshackle<span class="w"> </span>prd<span class="w"> </span><span class="nb">test</span><span class="w"> </span>mydevice.prd<span class="w"> </span>-sl<span class="w"> </span><span class="m">3000</span><span class="w"> </span>-c<span class="w"> </span>aescbc
</span></code></pre></div>
</div>
<hr />
<h2 id="serve"><code>serve</code><a class="headerlink" href="#serve" title="Permanent link">&para;</a></h2>
<p>Serve your local Widevine/PlayReady devices and the REST API for remote access. Built on <code>aiohttp</code>.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>unshackle serve [OPTIONS]
<div class="language-text highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>unshackle serve [OPTIONS]
</span></code></pre></div>
<table>
<thead>
@@ -3890,31 +3929,31 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
<div class="admonition warning">
<p class="admonition-title">Configure <code>api_secret</code> first</p>
<p>Unless you pass <code>--no-key</code>, <code>serve.api_secret</code> must be set in your config. Requests authenticate with the <code>X-Secret-Key</code> header. <code>--no-key</code> disables authentication entirely. Only use it on a trusted, private network.</p>
<div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="nt">serve</span><span class="p">:</span>
</span><span id="__span-21-2"><a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="w"> </span><span class="nt">api_secret</span><span class="p">:</span><span class="w"> </span><span class="s">"your-api-secret"</span>
</span><span id="__span-21-3"><a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="w"> </span><span class="nt">users</span><span class="p">:</span>
</span><span id="__span-21-4"><a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="w"> </span><span class="nt">your-secret-key</span><span class="p">:</span>
</span><span id="__span-21-5"><a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="w"> </span><span class="nt">devices</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"device_name"</span><span class="p p-Indicator">]</span><span class="w"> </span><span class="c1"># Widevine devices</span>
</span><span id="__span-21-6"><a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="w"> </span><span class="nt">playready_devices</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"device_name"</span><span class="p p-Indicator">]</span><span class="w"> </span><span class="c1"># PlayReady devices</span>
</span><span id="__span-21-7"><a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
<div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="nt">serve</span><span class="p">:</span>
</span><span id="__span-23-2"><a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a><span class="w"> </span><span class="nt">api_secret</span><span class="p">:</span><span class="w"> </span><span class="s">"your-api-secret"</span>
</span><span id="__span-23-3"><a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a><span class="w"> </span><span class="nt">users</span><span class="p">:</span>
</span><span id="__span-23-4"><a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a><span class="w"> </span><span class="nt">your-secret-key</span><span class="p">:</span>
</span><span id="__span-23-5"><a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a><span class="w"> </span><span class="nt">devices</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"device_name"</span><span class="p p-Indicator">]</span><span class="w"> </span><span class="c1"># Widevine devices</span>
</span><span id="__span-23-6"><a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a><span class="w"> </span><span class="nt">playready_devices</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"device_name"</span><span class="p p-Indicator">]</span><span class="w"> </span><span class="c1"># PlayReady devices</span>
</span><span id="__span-23-7"><a id="__codelineno-23-7" name="__codelineno-23-7" href="#__codelineno-23-7"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
</span></code></pre></div>
</div>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>unshackle<span class="w"> </span>serve
</span><span id="__span-22-2"><a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>-h<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span>-p<span class="w"> </span><span class="m">8080</span>
</span><span id="__span-22-3"><a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--api-only
</span><span id="__span-22-4"><a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--remote-only
</span><span id="__span-22-5"><a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--caddy
<div class="language-shell highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>unshackle<span class="w"> </span>serve
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>-h<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span>-p<span class="w"> </span><span class="m">8080</span>
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--api-only
</span><span id="__span-24-4"><a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--remote-only
</span><span id="__span-24-5"><a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a>unshackle<span class="w"> </span>serve<span class="w"> </span>--caddy
</span></code></pre></div>
</div>
<hr />
<h2 id="util"><code>util</code><a class="headerlink" href="#util" title="Permanent link">&para;</a></h2>
<p>Various helper media utilities. When you give a command a directory, it processes every <code>.mkv</code>/<code>.mp4</code> inside it in natural (S01E01 before S01E10) order.</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>unshackle util COMMAND [ARGS]...
<div class="language-text highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>unshackle util COMMAND [ARGS]...
</span></code></pre></div>
<h3 id="util-refresh-services"><code>util refresh-services</code><a class="headerlink" href="#util-refresh-services" title="Permanent link">&para;</a></h3>
<div class="language-text highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>unshackle util refresh-services
<div class="language-text highlight"><pre><span></span><code><span id="__span-26-1"><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a>unshackle util refresh-services
</span></code></pre></div>
<p>Force a refresh (git pull / hard reset) of all service repos configured under <code>directories.services</code>. This updates the clones on disk. A server that is already running reloads the changed services through <code>POST /api/maintenance/refresh-services</code> or <code>serve.services_refresh_interval</code> instead.</p>
<h3 id="util-crop-path-aspect"><code>util crop PATH ASPECT</code><a class="headerlink" href="#util-crop-path-aspect" title="Permanent link">&para;</a></h3>
@@ -3988,11 +4027,11 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
</table>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>unshackle<span class="w"> </span>util<span class="w"> </span>refresh-services
</span><span id="__span-25-2"><a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a>unshackle<span class="w"> </span>util<span class="w"> </span>crop<span class="w"> </span>video.mkv<span class="w"> </span><span class="m">2</span>.39:1
</span><span id="__span-25-3"><a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>unshackle<span class="w"> </span>util<span class="w"> </span>crop<span class="w"> </span>./season/<span class="w"> </span><span class="m">16</span>:9<span class="w"> </span>--pillar<span class="w"> </span>-o<span class="w"> </span><span class="m">10</span>
</span><span id="__span-25-4"><a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a>unshackle<span class="w"> </span>util<span class="w"> </span>range<span class="w"> </span>video.mkv<span class="w"> </span>--full
</span><span id="__span-25-5"><a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a>unshackle<span class="w"> </span>util<span class="w"> </span><span class="nb">test</span><span class="w"> </span>video.mkv<span class="w"> </span>-m<span class="w"> </span><span class="m">0</span>:v:0
<div class="language-shell highlight"><pre><span></span><code><span id="__span-27-1"><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>unshackle<span class="w"> </span>util<span class="w"> </span>refresh-services
</span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a>unshackle<span class="w"> </span>util<span class="w"> </span>crop<span class="w"> </span>video.mkv<span class="w"> </span><span class="m">2</span>.39:1
</span><span id="__span-27-3"><a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>unshackle<span class="w"> </span>util<span class="w"> </span>crop<span class="w"> </span>./season/<span class="w"> </span><span class="m">16</span>:9<span class="w"> </span>--pillar<span class="w"> </span>-o<span class="w"> </span><span class="m">10</span>
</span><span id="__span-27-4"><a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a>unshackle<span class="w"> </span>util<span class="w"> </span>range<span class="w"> </span>video.mkv<span class="w"> </span>--full
</span><span id="__span-27-5"><a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a>unshackle<span class="w"> </span>util<span class="w"> </span><span class="nb">test</span><span class="w"> </span>video.mkv<span class="w"> </span>-m<span class="w"> </span><span class="m">0</span>:v:0
</span></code></pre></div>
</div>
<hr />
+2 -2
View File
@@ -3265,8 +3265,8 @@ either enum <strong>names</strong> or their <strong>values</strong>, comma-separ
<p class="admonition-title">HYBRID requires dovi_tool</p>
<p><code>-r HYBRID</code> makes a single hybrid track by injecting the Dolby Vision RPU
metadata onto an HDR10/HDR10+ base layer with <strong>dovi_tool</strong>.
It requires the <code>dovi_tool</code> binary, resolved from unshackle's <code>binaries/</code> folder or
your <code>PATH</code>. The normal case is a DV track plus an HDR10 or HDR10+ base. With HDR10+
It requires the <code>dovi_tool</code> binary, resolved from unshackle's <code>binaries/</code> folder,
the <code>binaries</code> folder of your user data directory, or your <code>PATH</code>. The normal case is a DV track plus an HDR10 or HDR10+ base. With HDR10+
and no DV, unshackle converts the HDR10+ metadata to DV instead, which also needs
<code>hdr10plus_tool</code>. With no DV and no HDR10+, the title fails.
When HDR10+ is present, unshackle prefers it over HDR10 as the base layer.</p>
+2 -2
View File
@@ -2938,8 +2938,8 @@ encrypted file (for Widevine, PlayReady, and ClearKey-CENC):</p>
<li><strong>shaka-packager</strong> is the default.</li>
<li><strong>mp4decrypt</strong> is part of the Bento4 tools.</li>
</ul>
<p>Both must be discoverable in unshackle's bundled <code>binaries/</code> directory or on your
<code>PATH</code>. If the selected tool's binary is missing at decrypt time, unshackle raises an
<p>Both must be discoverable in unshackle's bundled <code>binaries/</code> directory, the
<code>binaries</code> folder of your user data directory, or on your <code>PATH</code>. If the selected tool's binary is missing at decrypt time, unshackle raises an
"executable not found but is required" error. See <a href="../../getting-started/installation/">dependencies</a> for
installation.</p>
<p>You choose the backend with the <code>decryption</code> config key. It can be a single value applied
+1 -1
View File
@@ -2585,7 +2585,7 @@
<div class="admonition example">
<p class="admonition-title">A required tool is missing</p>
<p><strong>Symptom:</strong> decryption, muxing, or analysis fails early, sometimes with a "binary not found" style error.</p>
<p><strong>Inspect:</strong> use <code>unshackle env check</code> and look for a red <code>✗</code> on a <strong>required</strong> row. Install the missing tool and re-run.</p>
<p><strong>Inspect:</strong> use <code>unshackle env check</code> and look for a red <code>✗</code> on a <strong>required</strong> row. Run <code>unshackle setup</code> to install it, or install it by hand, and re-run.</p>
</div>
<div class="admonition example">
<p class="admonition-title">Decryption produces garbage or fails</p>
+24 -8
View File
@@ -2166,31 +2166,47 @@ at a title and it will:</p>
</tbody>
</table>
<h2 id="installation-at-a-glance">Installation at a glance<a class="headerlink" href="#installation-at-a-glance" title="Permanent link">&para;</a></h2>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Install as a tool</label><label for="__tabbed_1_2">Run from a clone</label></div>
<p>A git clone with the install script is the recommended way to install unshackle.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Linux (recommended)</label><label for="__tabbed_1_2">Windows (recommended)</label><label for="__tabbed_1_3">Advanced: uv tool</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>unshackle<span class="w"> </span>--help
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>unshackle
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>sh<span class="w"> </span>install.sh
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>env<span class="w"> </span>check
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nb">cd</span><span class="w"> </span>unshackle
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>uv<span class="w"> </span>run<span class="w"> </span>unshackle<span class="w"> </span>--help
<div class="language-bat highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git clone https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="k">cd</span> unshackle
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>.\install.bat
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>uv run unshackle env check
</span></code></pre></div>
</div>
<div class="tabbed-block">
<div class="language-shell highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/unshackle-dl/unshackle.git
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>unshackle<span class="w"> </span>setup
</span></code></pre></div>
<p>This installs unshackle into the tool folder of <code>uv</code>, not a folder that you
choose. <code>unshackle setup</code> then puts the tools, config, and data in your user
data and config directories.</p>
</div>
</div>
</div>
<p>The install script installs <code>uv</code> and unshackle, then runs <code>unshackle setup</code>. In a
clone, run every command as <code>uv run unshackle ...</code>. The examples on this site use
the bare <code>unshackle</code> command.</p>
<div class="admonition note">
<p class="admonition-title">External tools</p>
<p>unshackle shells out to FFmpeg, MKVToolNix, shaka-packager, Bento4, and
<code>dovi_tool</code> for decryption, repacking, muxing, and Dolby Vision work. See
<code>dovi_tool</code> for decryption, repacking, muxing, and Dolby Vision work.
<code>unshackle setup</code> downloads them when a portable build exists for your system. See
<a href="getting-started/installation/">Installation</a> for the full list and recommended versions.</p>
</div>
<h2 id="a-first-download">A first download<a class="headerlink" href="#a-first-download" title="Permanent link">&para;</a></h2>
<p>Every download is three parts: the <code>dl</code> command, a <strong>service tag</strong>, and the
service's title argument (a URL, ID, or slug).</p>
<div class="language-shell highlight"><span class="filename">Download a 1080p title with English audio</span><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-q<span class="w"> </span><span class="m">1080</span><span class="w"> </span>-l<span class="w"> </span>en<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
<div class="language-shell highlight"><span class="filename">Download a 1080p title with English audio</span><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-q<span class="w"> </span><span class="m">1080</span><span class="w"> </span>-l<span class="w"> </span>en<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<p>The <code>dl</code> command carries all the quality, language, and output flags. The service
tag (<code>EXAMPLE</code> above) selects which streaming service to talk to, and unshackle passes
File diff suppressed because one or more lines are too long
+38 -38
View File
@@ -2,154 +2,154 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-09-29</lastmod>
<lastmod>2026-10-01</lastmod>
</url>
</urlset>
BIN
View File
Binary file not shown.