pear-desktop README

The project's README from github.com/pear-devs/pear-desktop. As one markdown file: README.md.

Special thanks to:

Warp sponsorship

Warp, built for coding with multiple AI agents

Available for macOS, Linux, & Windows

:pear: Pear Desktop

GitHub release GitHub license eslint code style Build status GitHub All Releases

Known Vulnerabilities

[!IMPORTANT] ⚠️ Disclaimer

No Affiliation

This project, and its contributors, are not affiliated with, authorized by, endorsed by, or in any way officially connected with Google LLC, YouTube, or any of their subsidiaries or affiliates. This is an independent, non-profit, and unofficial extension developed by a team of volunteers with the goal of providing a desktop experience.

Trademarks

The names "Google" and "YouTube Music", as well as related names, marks, emblems, and images, are registered trademarks of their respective owners. Any use of these trademarks is for identification and reference purposes only and does not imply any association with the trademark holder. We have no intention of infringing upon these trademarks or causing harm to the trademark holders.

Limitation of Liability

This application (extension) is provided "AS IS", and you use it at your own risk. In no event shall the developers or contributors be liable for any claim, damages, or other liability, including any legal consequences, arising from, out of, or in connection with the software or the use or other dealings in the software. The responsibility for any and all outcomes of using this software rests entirely with the user.

Content

Translation

You can help with translation on Hosted Weblate.

translation status translation status 2

Download

You can check out the latest release to quickly find the latest version.

Arch Linux

Install the pear-desktop package from the AUR. For AUR installation instructions, take a look at this wiki page.

Solus

sudo eopkg install pear-desktop

macOS

You can install the app using Homebrew (see the cask definition):

brew install pear-devs/pear/pear-desktop

If you install the app manually and get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal:

/usr/bin/xattr -cr /Applications/Pear\ Desktop.app

Windows

You can use the Scoop package manager to install the pear-desktop package from the extras bucket.

scoop bucket add extras
scoop install extras/pear-desktop

Alternately you can use Winget, Windows 11s official CLI package manager to install the pear-devs.pear-desktop package.

Note: Microsoft Defender SmartScreen might block the installation since it is from an "unknown publisher". This is also true for the manual installation when trying to run the executable(.exe) after a manual download here on github (same file).

winget install pear-devs.pear-desktop

How to install without a network connection? (in Windows)

Themes

You can load CSS files to change the look of the application (Options > Visual Tweaks > Themes).

Some predefined themes are available in https://github.com/kerichdev/themes-for-ytmdesktop-player.

Dev

git clone https://github.com/pear-devs/pear-desktop
cd pear-desktop
pnpm install --frozen-lockfile
pnpm dev

Instead of installing pnpm on your system, you can also use devcontainers. You can use devcontainers either as a development environment in VS Code, or as a way to easily build the project without installing dependencies on your host system.

Note that this has it's own limitations (for example, GUI doesn't work on, at least some, Linux hosts).

Build your own plugins

Using plugins, you can:

Creating a plugin

Create a folder in src/plugins/YOUR-PLUGIN-NAME:

import style from './style.css?inline'; // import style as inline

import { createPlugin } from '@/utils';

export default createPlugin({
  name: 'Plugin Label',
  restartNeeded: true, // if value is true, ytmusic show restart dialog
  config: {
    enabled: false,
  }, // your custom config
  stylesheets: [style], // your custom style,
  menu: async ({ getConfig, setConfig }) => {
    // All *Config methods are wrapped Promise<T>
    const config = await getConfig();
    return [
      {
        label: 'menu',
        submenu: [1, 2, 3].map((value) => ({
          label: `value ${value}`,
          type: 'radio',
          checked: config.value === value,
          click() {
            setConfig({ value });
          },
        })),
      },
    ];
  },
  backend: {
    start({ window, ipc }) {
      window.maximize();

      // you can communicate with renderer plugin
      ipc.handle('some-event', () => {
        return 'hello';
      });
    },
    // it fired when config changed
    onConfigChange(newConfig) { /* ... */ },
    // it fired when plugin disabled
    stop(context) { /* ... */ },
  },
  renderer: {
    async start(context) {
      console.log(await context.ipc.invoke('some-event'));
    },
    // Only renderer available hook
    onPlayerApiReady(api, context) {
      // set plugin config easily
      context.setConfig({ myConfig: api.getVolume() });
    },
    onConfigChange(newConfig) { /* ... */ },
    stop(_context) { /* ... */ },
  },
  preload: {
    async start({ getConfig }) {
      const config = await getConfig();
    },
    onConfigChange(newConfig) {},
    stop(_context) {},
  },
});

Common use cases

// index.ts
import style from './style.css?inline'; // import style as inline

import { createPlugin } from '@/utils';

export default createPlugin({
  name: 'Plugin Label',
  restartNeeded: true, // if value is true, pear-desktop will show a restart dialog
  config: {
    enabled: false,
  }, // your custom config
  stylesheets: [style], // your custom style
  renderer() {} // define renderer hook
});

import { createPlugin } from '@/utils';

export default createPlugin({
  name: 'Plugin Label',
  restartNeeded: true, // if value is true, ytmusic will show the restart dialog
  config: {
    enabled: false,
  }, // your custom config
  renderer() {
    console.log('hello from renderer');
  } // define renderer hook
});

Build

  1. Clone the repo
  2. Follow this guide to install pnpm
  3. Run pnpm install --frozen-lockfile to install dependencies
  4. Run pnpm build:OS

Builds the app for macOS, Linux, and Windows, using electron-builder.

Building in devcontainer

  1. Clone the repo;
  2. Open the folder in VS Code;
  3. Reopen in container when prompted;
  4. Run pnpm build as above (choosing the desired target);
  5. Collect the built files from the dist folder.

Since devcontainer uses a mount for the workspace, the built files will be available on the host system as well.

Production Preview

pnpm start

Tests

pnpm test

Uses Playwright to test the app.

License

MIT © pear-devs

FAQ

Why apps menu isn't showing up?

If Hide Menu option is on - you can show the menu with the alt key (or ` [backtick] if using the in-app-menu plugin)

pear-desktop (pear-devs/pear-desktop)

Searching Database…

33.8K ·GitHub
Pear-desktop
Что это такое?Pear — это настольное приложение с открытым исходным кодом на Electron, которое оборачивает YouTube Music в интерфейс, похожий на нативный. Его независимо разрабатывают добровольцы, и оно не имеет официальной связи с Google или YouTube.
Это расширение для браузера или самостоятельное приложение?Это самостоятельное настольное приложение на Electron, а не расширение для браузера: оно собирается и распространяется отдельно для macOS, Linux и Windows.
Нужны ли мне pnpm или Node, чтобы им пользоваться?Для готовых сборок — нет, они просто запускаются. Для сборки из исходников нужны Node 22+ и pnpm 11+, затем `pnpm install --frozen-lockfile`, а после этого `pnpm build:OS`.
Есть ли подводные камни при установке, о которых стоит знать?В Windows Microsoft Defender SmartScreen может пометить установщик как исходящий от «неизвестного издателя»; в macOS вручную установленное приложение может показать ошибку «повреждено и не может быть открыто», которая исправляется командой в терминале.
Можно ли изменить оформление с помощью тем или своего CSS?Да — в Options > Visual Tweaks > Themes можно загрузить свои CSS-файлы, а в проекте есть несколько готовых тем, с которых можно начать.
Можно ли написать собственные плагины?Да — создайте папку src/plugins/YOUR-PLUGIN-NAME с файлом index.ts; плагины получают Electron BrowserWindow, поэтому можно внедрять CSS, менять HTML или обмениваться данными с главным процессом через ipcMain.
Можно ли установить на Windows без подключения к интернету?Да — скачайте со страницы релизов файл .nsis.7z для вашей архитектуры и соответствующий установщик -Setup.exe, положите их в одну папку и запустите установщик офлайн.
What are similar projects?youtube-music, AlgerMusicPlayer, nuclear, listen1_desktop, Omarchy-Spotify, YesPlayMusic, stemkit, openspot-music-app
Which topics is it in?macosx, youtube-music, mac, music-player, electron-app, music, playwright, theme, node, audio, electron, customization
Creator
pear-devs
Size
22.5 MB
Stars
33.8K
Updated
CommitOct 12Releasev3.12.0Jun 28
Age
7y
Commits · 90 Days