feat(setup): add unshackle setup command and cross-platform install scripts

setup downloads the external tools, writes a first config and imports CDM devices; install.sh and install.bat bootstrap uv and run it.
This commit is contained in:
imSp4rky
2026-10-01 12:21:24 -06:00
parent fdcc653b66
commit c7ab04028a
19 changed files with 1546 additions and 166 deletions
+10 -7
View File
@@ -13,19 +13,22 @@ The full loop runs end to end: start the server, authenticate, submit a download
You need a working unshackle install with services and CDM devices already configured, exactly as you would for a normal command-line download. If `unshackle dl` works for you, the API will too, since it runs the identical download pipeline.
=== "Installed as a tool"
```shell
uv tool install git+https://github.com/unshackle-dl/unshackle.git
unshackle --help
```
If you have no install yet, follow [Installation](../../getting-started/installation.md). Then check your tools:
=== "From a clone"
```shell
uv run unshackle --help
uv run unshackle env check
```
=== "Installed as a uv tool"
```shell
unshackle env check
```
This page uses the bare `unshackle` command. From a git clone, the recommended install, run each command as `uv run unshackle ...`.
---
## Step 1: Configure an API secret