Move authentication docs to its own chapter

This commit is contained in:
Ivan Habunek
2025-03-03 09:51:31 +01:00
parent d2f0e2c8da
commit bf4a97a276
8 changed files with 41 additions and 19 deletions

View File

@ -3,6 +3,11 @@ twitch-dl changelog
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
### [2.11.0 (TBA)](https://github.com/ihabunek/twitch-dl/releases/tag/2.11.0)
* Download clips concurrently, which greatly improves the download speed when
downloading multiple clips when using `clips --download`
### [2.10.0 (2025-01-09)](https://github.com/ihabunek/twitch-dl/releases/tag/2.10.0)
* Add chat --image-format option to specify intermediate frame format

View File

@ -11,6 +11,7 @@
- [twitch-dl env](commands/env.md)
- [twitch-dl info](commands/info.md)
- [twitch-dl videos](commands/videos.md)
- [Authentication](authentication.md)
- [Environment variables](environment_variables.md)
- [Shell completion](shell_completion.md)

View File

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

23
docs/authentication.md Normal file
View File

@ -0,0 +1,23 @@
Authentication
==============
Some videos are subscriber-only and require you to be logged in. To accomplish
this you need to find your auth token. It can be found using your browser, in a
cookie named `auth_token`.
1. Open twitch.tv in your browser and make sure you're logged in.
2. Open developer tools (F12 shortcut in Firefox and Chrome).
3. Open the `Storage` tab on Firefox, or `Application` tab in Chrome.
4. Click on `Cookies``https://www.twitch.tv/` in the sidebar.
5. Find the `auth-token` cookie in the list and copy it's value.
![How to find the auth token in dev tools](./auth_token.png)
The auth token will be a 30 character long string of random letters and numbers,
something like `iduetx4i107rn4b9wrgctf590aiktv`. Then you can pass it to `info`
and `download` commands:
```
twitch-dl info 221837124 --auth-token iduetx4i107rn4b9wrgctf590aiktv
twitch-dl download 221837124 --auth-token iduetx4i107rn4b9wrgctf590aiktv
```

View File

@ -3,6 +3,11 @@ twitch-dl changelog
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
### [2.11.0 (TBA)](https://github.com/ihabunek/twitch-dl/releases/tag/2.11.0)
* Download clips concurrently, which greatly improves the download speed when
downloading multiple clips when using `clips --download`
### [2.10.0 (2025-01-09)](https://github.com/ihabunek/twitch-dl/releases/tag/2.10.0)
* Add chat --image-format option to specify intermediate frame format

View File

@ -176,21 +176,4 @@ A couple of examples:
### Downloading subscriber-only VODs
To download sub-only VODs, you need to find your auth token. It can be found
using your browser, in a cookie named `auth_token`.
1. Open twitch.tv in your browser and make sure you're logged in.
2. Open developer tools (F12 shortcut in Firefox and Chrome).
3. Open the `Storage` tab on Firefox, or `Application` tab in Chrome.
4. Click on `Cookies``https://www.twitch.tv/` in the sidebar.
5. Find the `auth-token` cookie in the list and copy it's value.
![How to find the auth token in dev tools](./auth_token.png)
The auth token will be a 30 character long string of random letters and numbers,
something like `iduetx4i107rn4b9wrgctf590aiktv`. Then you can pass this to the
download command:
```
twitch-dl download 221837124 --auth-token iduetx4i107rn4b9wrgctf590aiktv
```
Some videos are subscriber-only and require you to be logged in. To accomplish this follow the instructions in the [Authentication chapter](/authentication.md).

View File

@ -13,6 +13,11 @@ twitch-dl info [OPTIONS] ID
<table>
<tbody>
<tr>
<td class="code">-a, --auth-token TEXT</td>
<td>Authentication token, passed to Twitch to access subscriber only VODs. Can be copied from the <code>auth_token</code> cookie in any browser logged in on Twitch.</td>
</tr>
<tr>
<td class="code">--json</td>
<td>Print data as JSON rather than human readable text</td>

View File

@ -15,7 +15,7 @@ twitch-dl videos [OPTIONS] CHANNEL_NAME
<tbody>
<tr>
<td class="code">-a, --all</td>
<td>Fetch all clips, overrides --limit</td>
<td>Fetch all videos, overrides --limit</td>
</tr>
<tr>