-
-
Notifications
You must be signed in to change notification settings - Fork 456
feat: cleanup installation page & improved cli page #103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ohitstom
wants to merge
4
commits into
spicetify:main
Choose a base branch
from
ohitstom:installation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| title: Command Line | ||
| description: 👾 Using Spicetify from the command line (CLI). | ||
| --- | ||
|
|
||
| ## Post Installation | ||
| :::tip | ||
|
|
||
| If you are coming off a fresh install of Spotify we recommend you open Spotify for atleast 60 seconds and login to generate the files that Spicetify depend on for application. | ||
|
|
||
| ::: | ||
|
|
||
| Run with no command once to generate config file: | ||
|
|
||
| ```bash | ||
| spicetify | ||
| ``` | ||
| Make sure config file is created successfully and there is no error. | ||
|
|
||
| Install addons and update your config file then run: | ||
|
|
||
| ```bash | ||
| spicetify backup apply | ||
| ``` | ||
| :::note | ||
|
|
||
| If you use Linux or macOS, before applying Spicetify, you need to gain write permission on Spotify files, by running the commands: | ||
|
|
||
| ```bash | ||
| sudo chmod a+wr /opt/spotify | ||
| sudo chmod a+wr /opt/spotify/Apps -R | ||
| ``` | ||
| *Your Spotify location may differ* | ||
|
|
||
| ::: | ||
|
|
||
|
|
||
| From now, after changing colors in `color.ini` or CSS in `user.css`, you just need to run: | ||
|
|
||
| ```bash | ||
| spicetify update | ||
| ``` | ||
|
|
||
| to update your theme. | ||
|
|
||
| In Spotify, hit <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>R</kbd> / <kbd>Command</kbd> <kbd>Shift</kbd> <kbd>R</kbd> to reload and receive visual update of your theme. | ||
|
|
||
| For other commands and additional flags information, please run: | ||
|
|
||
| ```bash | ||
| spicetify --help | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| ### Chainable | ||
|
|
||
| - `backup`: Start backup and preprocessing app files. | ||
| - `apply`: Apply customization. | ||
| - `update`: By default, updates theme's CSS, JS, colors, and assets. Use with flag "-e" to update extensions. | ||
| - `restore`: Restore Spotify to its original state. | ||
| - `clear`: Clear current backup files. | ||
| - `enable-devtools`: Enable Spotify's developer tools. | ||
| - `restart`: Restart Spotify client. | ||
| - `watch`: Enter watch mode. To update on change, use with any combination of the following flags: | ||
| - "-e" (for extensions) | ||
| - "-a" (for custom apps) | ||
| - "-s" (for the active theme; color.ini, user.css, theme.js, and assets) | ||
| - "-l" (for extensions, custom apps, and active theme) | ||
|
|
||
| ### Standalone | ||
|
|
||
| - `upgrade` Upgrade spicetify to the latest version. | ||
| - `path`: Prints path of Spotify's executable, userdata, and more. | ||
| - `path all`: all paths. | ||
| - `path`: executable path. | ||
| - `path userdata`: userdata path. | ||
| - Toggle focus with flags: | ||
| - "-e" (for extensions), options: root, extension name, blank for all. | ||
| - "-a" (for custom apps), options: root, app-name, blank for all. | ||
| - "-s" (for the active theme), options: root, folder, color, css, js, assets, blank for all. | ||
| - "-c" (for config.ini), options: N/A. | ||
|
|
||
| - `color`: Prints hex for color.inis. | ||
| - Print all color fields and values: `spicetify color` | ||
| - Change theme's one or multiple color values: `spicetify color <field> <value> [<field> <value> ...]` | ||
| - `<value>` can be in hex or decimal (rrr,ggg,bbb) format. | ||
| - Example usage: | ||
| - Change `main` to `ff0000`: `spicetify color main ff0000` | ||
| - Change `sidebar` to `00ff00` and `button` to `0000ff`: `spicetify color sidebar 00ff00 button 0000ff` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add config file location in the next line? Like:
"After you have Spotify location, set
spotify_pathin the config file(~/.config/spicetify/config-xpui.ini)to that directory:"