Skip to content

Commit d2a2fa8

Browse files
SunsetTechuilaSunsetTechuila
authored
docs(development/spotify-cli-flags): update info (#163)
1 parent 3f32d21 commit d2a2fa8

File tree

1 file changed

+101
-45
lines changed

1 file changed

+101
-45
lines changed

‎docs/development/spotify-cli-flags.md‎

Lines changed: 101 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,104 @@ title: Spotify CLI Flags
33
description: 🚩 Flags to alter the behavior of the Spotify.
44
---
55

6-
| Flag | Description |
7-
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
8-
| `--uri=<uri>` | Start the client normally, but automatically navigate to the URI when initialized. |
9-
| `--protocol-uri=<uri>` | Identical to --uri, but only used from the Windows protocol handler, so we can apply extra security restrictions. |
10-
| `--mu=<value>` | Start with a special cache directory. Allows you to run multiple clients at the same time. Value can be anything (will be used as part of the cache name). |
11-
| `--username=<username>` | Use to automatically sign in on startup. Use together with `--password`. |
12-
| `--password=<password>` | Use to automatically sign in on startup. Use together with `--username`. |
13-
| `--cache-path=<path>` | Use as root for the cache directory. |
14-
| `--log-file=<path>` | Save log output to file (extension needs to be '.log'). |
15-
| `--trace-file=<path>` | Save a trace file to this path. |
16-
| `--show-console` | Show more log output. |
17-
| `--allow-upgrades` |
18-
| `--app-directory=<path>` | Specify Apps directory |
19-
| `--app-icon-overlay` |
20-
| `--apr` |
21-
| `--autostart` |
22-
| `--bridge-log-filename` |
23-
| `--enable-audio-graph` |
24-
| `--enable-developer-mode` |
25-
| `--experimental-languages` |
26-
| `--trigger-ta-crash` |
27-
| `--experimental-network` |
28-
| `--force-auto-update` |
29-
| `--connect-debug-level` |
30-
| `--immediate-widevine-cdm-download` |
31-
| `--log-detailed-request-account` |
32-
| `--append-log-file` |
33-
| `--disable-crash-reporting` |
34-
| `--transparent-window-controls` | Make window control box semi-transparent. Only works on Windows |
35-
| `--maximized` |
36-
| `--minimized` | Start the app with the window minimized. Only works on Windows. |
37-
| `--performance-tracing` |
38-
| `--remote-app-config` |
39-
| `--product-version` |
40-
| `--remote-debugging-port=<port>` | Enable remote debugging |
41-
| `--test-auto-update-success-file-path` |
42-
| `--update-immediately` |
43-
| `--upgrade-failed` |
44-
| `--weblogin-endpoint` |
45-
| `--disallow-multiple-instances` |
46-
| `--force-cef-http` |
47-
| `--startup-success-file-path` |
48-
| `--update-endpoint-override` |
49-
| `--minimum-update-request-interval` |
50-
| `--disable-update-restarts` |
6+
## List of flags
7+
8+
**When adding flags to your spicetify config, separate each one with `|`.**
9+
10+
| Flag | Description |
11+
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12+
| `--allow-upgrades` | |
13+
| `--append-log-file` | |
14+
| `--app-directory=<path>` | Specify the "Apps" directory path. Used by spicetify for modyfing Spotify from Microsoft Store. |
15+
| `--app-icon-overlay` | |
16+
| `--apr` | |
17+
| `--audio-api` | |
18+
| `--autostart` | |
19+
| `--bridge-log-filename` | |
20+
| `--cache-path=<path>` | Use as root for the cache directory. |
21+
| `--campaign-id` | |
22+
| `--connect-debug-level` | |
23+
| `--disable-cef-views` | |
24+
| `--disable-crash-reporting` | |
25+
| `--disable-update-restarts` | |
26+
| `--disallow-multiple-instances` | |
27+
| `--enable-audio-graph` | |
28+
| `--enable-cef-views` | |
29+
| `--enable-chrome-runtime` | Switches runtime from Alloy to Chrome on Spotify versions below 1.2.34. See [this issue on GitHub](https://github.com/chromiumembedded/cef/issues/3685) for details about the differences. |
30+
| `--enable-developer-mode` | Used to enable the developer mode like `spicetify enable-devtools`. Stopped working long time ago. |
31+
| `--event-sender-send-interval` | |
32+
| `--experimental-languages` | |
33+
| `--experimental-network` | |
34+
| `--force-auto-update` | |
35+
| `--force-cef-http` | |
36+
| `--immediate-widevine-cdm-download` | |
37+
| `--log-detailed-request-account` | |
38+
| `--log-file=<path>` | Save log output to file (extension needs to be '.log'). |
39+
| `--maximized` | |
40+
| `--minimum-update-request-interval` | |
41+
| `--minimized` | Start the app with the window minimized. Only works on Windows. |
42+
| `--mu=<value>` | Start with a special cache directory. Allows you to run multiple clients at the same time. Value can be anything (will be used as part of the cache name). |
43+
| `--password=<password>` | Use to automatically sign in on startup. Use together with `--username`. No longer works. |
44+
| `--performance-tracing` | |
45+
| `--product-version` | |
46+
| `--protocol-uri=<uri>` | Identical to --uri, but only used from the Windows protocol handler, so we can apply extra security restrictions. |
47+
| `--remote-allow-origins=<url>` | Required to use remote debugging since Spotify 1.2.8 due to security changes in Chromium 111. Example configuration: `--remote-debugging-port=8088 \| --remote-allow-origins=http://localhost:8088`. |
48+
| `--remote-app-config` | |
49+
| `--remote-debugging-port=<port>` | Enable remote debugging. |
50+
| `--remember-cmd-login` | |
51+
| `--show-console` | Show more log output. |
52+
| `--startup-success-file-path` | |
53+
| `--test-auto-update-success-file-path` | |
54+
| `--trace-file=<path>` | Save a trace file to this path. |
55+
| `--trigger-ta-crash` | |
56+
| `--update-endpoint-override=<url>` | Can be used to disable Spotify updates. Example configuration: `--update-endpoint-override=http://localhost`. |
57+
| `--update-immediately` | |
58+
| `--upgrade-failed` | |
59+
| `--uri=<uri>` | Start the client normally, but automatically navigate to the URI when initialized. |
60+
| `--use-event-sender-test-transport` | |
61+
| `--user-agent-product` | |
62+
| `--username=<username>` | Use to automatically sign in on startup. Use together with `--password`. No longer works. |
63+
| `--weblogin-endpoint` | |
64+
65+
**When added to spicetify config, the flags will only be applied when you launch Spotify using spicetify.** But you can also add them to the Spotify shortcut (on Windows) or `.desktop` file (on Linux) and use it to launch Spotify.
66+
67+
Most of the flags with some descriptions are taken directly from the Spotify executable.
68+
69+
## See also
70+
71+
- [General documentation on Chromium command-line switches](https://www.chromium.org/developers/how-tos/run-chromium-with-flags)
72+
73+
- [List of Chromium command-line switches](https://peter.sh/experiments/chromium-command-line-switches)
74+
75+
- List of CEF command-line switches in the source code: [1](https://github.com/chromiumembedded/cef/blob/master/tests/shared/common/client_switches.cc), [2](https://github.com/chromiumembedded/cef/blob/master/libcef/common/cef_switches.cc)
76+
77+
Don't expect every switch to work.
78+
79+
## Experimental features
80+
81+
Some Chromium experimental features can be enabled with `--enable-features=<comma-separated feature list>`, some require both a switch and a feature. Smooth scrolling is an example: `--enable-smooth-scrolling | --enable-features=WindowsScrollingPersonality`.
82+
There is no list of experimental features and they vary from version to version.
83+
84+
To enable experimental features in **Spotify newer than 1.2.33**:
85+
86+
1. Launch it in the developer mode
87+
2. Press *Ctrl + Shift + T*
88+
3. Press *Ctrl + N*
89+
4. Navigate to the `chrome://flags` page using the address bar
90+
5. Enable the ones you want
91+
6. Press the "Relaunch" button
92+
93+
If you are using **Spotify older than 1.2.34**:
94+
95+
1. Launch it with the `--enable-chrome-runtime` switch and developer mode enabled
96+
2. Press *Ctrl + Shift + T*
97+
3. Press *Ctrl + N*
98+
4. Navigate to the `chrome://flags` page using the address bar
99+
5. Enable the ones you want
100+
6. Press the "Relaunch" button
101+
7. Restart Spotify with the `--enable-chrome-runtime` switch and developer mode enabled
102+
8. Press *Ctrl + Shift + T*
103+
9. Click the `chrome://version` link
104+
10. Copy and paste the flags between `--flag-switches-begin` `--flag-switches-end` into your spicetify config and/or the shrotrcut/`.desktop` file you use to launch Spotify
105+
106+
The `--enable-chrome-runtime` switch and developer mode are not required for experimental features to work.

0 commit comments

Comments
 (0)