kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-14 13:05:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: apply simplified technical english across docs and docstrings.

Browse Source
This commit is contained in:
imSp4rky
2026-08-19 16:31:06 -06:00
parent 4177cb2267
commit 66971230c3
135 changed files with 2651 additions and 2570 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+14 -14
View File
@@ -6,13 +6,13 @@ well-tagged files, all driven from a single command-line tool, or served over a
REST API for automation.
It is a fork of [Devine](https://github.com/devine-dl/devine) with DASH, HLS, and
Smooth Streaming (ISM) parsing, both **Widevine** and **PlayReady** DRM support,
and a built-in HTTP server.
Smooth Streaming (ISM) parsing, both **Widevine** and **PlayReady** DRM, and a
built-in HTTP server.
!!! warning "Use responsibly"
unshackle is licensed under [GPL-3.0](https://github.com/unshackle-dl/unshackle/blob/main/LICENSE).
The [GPL-3.0](https://github.com/unshackle-dl/unshackle/blob/main/LICENSE) 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.
open, keep your own services private, and be kind.
## What it does
@@ -24,8 +24,8 @@ at a title and it will:
- Parse the streaming manifest: **DASH**, **HLS**, or **Smooth Streaming (ISM)**.
- Select the tracks you asked for by resolution, codec, bitrate, range, language,
and channel layout.
- Acquire decryption keys via a **Widevine** or **PlayReady** CDM, with optional
**key vaults** so keys are reused instead of re-licensed.
- Get the content keys through a **Widevine** or **PlayReady** CDM, with optional
**key vaults** that let unshackle reuse a content key instead of licensing it again.
- Decrypt, extract closed captions, repack, and **mux** the result into a Matroska
(`.mkv`) file with correct language, forced, and default flags.
- Tag and name the output using configurable filename templates.
@@ -76,19 +76,19 @@ service's title argument (a URL, ID, or slug).
unshackle dl -q 1080 -l en EXAMPLE 81234567
```
The `dl` command carries all the quality, language, and output flags; the service
tag (`EXAMPLE` above) selects which streaming service to talk to, and the value after it
is passed to that service. See the [Quickstart](getting-started/quickstart.md) to go from a fresh
install to your first file.
The `dl` command carries all the quality, language, and output flags. The service
tag (`EXAMPLE` above) selects which streaming service to talk to, and unshackle passes
the value after it to that service. See the [Quickstart](getting-started/quickstart.md)
to go from a fresh install to your first file.
## Where to go next
- **[Installation](getting-started/installation.md)**. Install unshackle and the external tools it depends on.
- **[Quickstart](getting-started/quickstart.md)**. Configure `unshackle.yaml` and run your first download.
- **[Quickstart](getting-started/quickstart.md)**. Configure `unshackle.yaml` and do your first download.
- **[Downloading](guide/downloading.md)**. The full `dl` command guide: quality, codecs, languages, track selection, and output.
- **[Configuration](getting-started/configuration-file.md)**. Where `unshackle.yaml` lives, the directory layout, and how to edit values. Full key list in the [Configuration Reference](reference/configuration/index.md).
- **[REST API](dev/rest-api/index.md)**. Run the `serve` HTTP server and drive downloads programmatically.
- **[Configuration](getting-started/configuration-file.md)**. Where `unshackle.yaml` lives, the directory layout, and how to edit values. Full config key list in the [Configuration Reference](reference/configuration/index.md).
- **[REST API](dev/rest-api/index.md)**. Operate the `serve` HTTP server and drive downloads programmatically.
!!! tip "Getting help"
Run `unshackle --help` or `unshackle dl --help` at any time. The community
Operate `unshackle --help` or `unshackle dl --help` at any time. The community
[Discord](https://discord.gg/mHYyPaCbFK) is the fastest place to ask questions.