https://github.com/ciderapp/plugin-template
Cider Plugin Starter Template
https://github.com/ciderapp/plugin-template
Last synced: 5 months ago
JSON representation
Cider Plugin Starter Template
- Host: GitHub
- URL: https://github.com/ciderapp/plugin-template
- Owner: ciderapp
- License: mit
- Created: 2024-10-03T21:44:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-29T01:32:05.000Z (about 1 year ago)
- Last Synced: 2025-10-29T06:38:46.632Z (8 months ago)
- Language: Vue
- Size: 118 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cider + Vue 3 + TypeScript + Vite
**(Requires Cider 2.5 or later)**
This is a template/boilerplate for creating Cider plugins using Vue 3, TypeScript, and Vite.
## Starting a new plugin project
Using **Node**
```bash
npx giget github:ciderapp/plugin-template your-plugin-name
```
Using **Bun**
```bash
bunx giget github:ciderapp/plugin-template your-plugin-name
```
## Available Commands
- `npm run dev` - Start development server, Cider can then listen to this server when you select "Enable Vite" from the main menu
- `npm run build` - Build the plugin to `dist/{plugin.config.ts:identifier}`
- `npm run prepare-marketplace` - Prepare a ZIP package in the correct format for the Cider Marketplace
## How to install after build
- Copy `dist/{plugin.config.ts:identifier}` to the `/plugins` directory of your Cider app data directory
- On Windows, this is `%APPDATA%\C2Windows\plugins`
- On macOS, this is `~/Library/Application Support/sh.cider.electron/plugins`
- On Linux, this is `~/.config/sh.cider.electron/plugins`
## Preparing a ZIP package for the Cider Marketplace
Run `npm run prepare-marketplace`
Running this script will create a ZIP file in the `publish` directory that is ready to be uploaded to the Cider Marketplace.
To configure this plugin edit `src/plugin.config.ts`