Deployed 8b10b79 with MkDocs version: 1.6.1

This commit is contained in:
2026-08-20 03:01:15 +00:00
parent 01248725da
commit 94f2b09ef6
40 changed files with 1967 additions and 1920 deletions
+14 -14
View File
@@ -2061,13 +2061,13 @@ media from streaming manifests, handles the DRM, and muxes everything into clean
well-tagged files, all driven from a single command-line tool, or served over a
REST API for automation.</p>
<p>It is a fork of <a href="https://github.com/devine-dl/devine">Devine</a> with DASH, HLS, and
Smooth Streaming (ISM) parsing, both <strong>Widevine</strong> and <strong>PlayReady</strong> DRM support,
and a built-in HTTP server.</p>
Smooth Streaming (ISM) parsing, both <strong>Widevine</strong> and <strong>PlayReady</strong> DRM, and a
built-in HTTP server.</p>
<div class="admonition warning">
<p class="admonition-title">Use responsibly</p>
<p>unshackle is licensed under <a href="https://github.com/unshackle-dl/unshackle/blob/main/LICENSE">GPL-3.0</a>.
<p>The <a href="https://github.com/unshackle-dl/unshackle/blob/main/LICENSE">GPL-3.0</a> licence covers unshackle.
Do not use it for content you do not have the rights to. Keep the core free and
open, keep service code private, and be kind.</p>
open, keep your own services private, and be kind.</p>
</div>
<h2 id="what-it-does">What it does<a class="headerlink" href="#what-it-does" title="Permanent link">&para;</a></h2>
<p>unshackle does everything except talk to the streaming platform. You write that part
@@ -2078,8 +2078,8 @@ at a title and it will:</p>
<li>Parse the streaming manifest: <strong>DASH</strong>, <strong>HLS</strong>, or <strong>Smooth Streaming (ISM)</strong>.</li>
<li>Select the tracks you asked for by resolution, codec, bitrate, range, language,
and channel layout.</li>
<li>Acquire decryption keys via a <strong>Widevine</strong> or <strong>PlayReady</strong> CDM, with optional
<strong>key vaults</strong> so keys are reused instead of re-licensed.</li>
<li>Get the content keys through a <strong>Widevine</strong> or <strong>PlayReady</strong> CDM, with optional
<strong>key vaults</strong> that let unshackle reuse a content key instead of licensing it again.</li>
<li>Decrypt, extract closed captions, repack, and <strong>mux</strong> the result into a Matroska
(<code>.mkv</code>) file with correct language, forced, and default flags.</li>
<li>Tag and name the output using configurable filename templates.</li>
@@ -2162,21 +2162,21 @@ at a title and it will:</p>
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>
</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 the value after it
is passed to that service. See the <a href="getting-started/quickstart/">Quickstart</a> to go from a fresh
install to your first file.</p>
<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
the value after it to that service. See the <a href="getting-started/quickstart/">Quickstart</a>
to go from a fresh install to your first file.</p>
<h2 id="where-to-go-next">Where to go next<a class="headerlink" href="#where-to-go-next" title="Permanent link">&para;</a></h2>
<ul>
<li><strong><a href="getting-started/installation/">Installation</a></strong>. Install unshackle and the external tools it depends on.</li>
<li><strong><a href="getting-started/quickstart/">Quickstart</a></strong>. Configure <code>unshackle.yaml</code> and run your first download.</li>
<li><strong><a href="getting-started/quickstart/">Quickstart</a></strong>. Configure <code>unshackle.yaml</code> and do your first download.</li>
<li><strong><a href="guide/downloading/">Downloading</a></strong>. The full <code>dl</code> command guide: quality, codecs, languages, track selection, and output.</li>
<li><strong><a href="getting-started/configuration-file/">Configuration</a></strong>. Where <code>unshackle.yaml</code> lives, the directory layout, and how to edit values. Full key list in the <a href="reference/configuration/">Configuration Reference</a>.</li>
<li><strong><a href="dev/rest-api/">REST API</a></strong>. Run the <code>serve</code> HTTP server and drive downloads programmatically.</li>
<li><strong><a href="getting-started/configuration-file/">Configuration</a></strong>. Where <code>unshackle.yaml</code> lives, the directory layout, and how to edit values. Full config key list in the <a href="reference/configuration/">Configuration Reference</a>.</li>
<li><strong><a href="dev/rest-api/">REST API</a></strong>. Operate the <code>serve</code> HTTP server and drive downloads programmatically.</li>
</ul>
<div class="admonition tip">
<p class="admonition-title">Getting help</p>
<p>Run <code>unshackle --help</code> or <code>unshackle dl --help</code> at any time. The community
<p>Operate <code>unshackle --help</code> or <code>unshackle dl --help</code> at any time. The community
<a href="https://discord.gg/mHYyPaCbFK">Discord</a> is the fastest place to ask questions.</p>
</div>