The package manager for Vencord userplugins.
Install, update, and manage plugins from decentralized JSON indexes.
Vencord's userplugin ecosystem is powerful but fragmented. Plugin authors host code in personal repos, users manually clone and rebuild, and there's no dependency resolution, no update tracking, and no discoverability.
venpm fixes this. Authors publish a small plugins.json index alongside their code. Users install plugins with a single command. venpm handles dependencies, version pinning, sparse git checkouts, and Vencord rebuilds automatically.
venpm install minimalCallBar
Resolved minimalCallBar@0.1.0 from kamaras-plugins
Optional: settingsHub, channelTabs (install with venpm install <name>)
Fetching via git (sparse checkout)...
Installed minimalCallBar@0.1.0
Rebuilding Vencord... done
npm install -g @kamaras/venpmOr run without installing:
npx @kamaras/venpm doctor# Check your environment
venpm doctor
# Point venpm at your Vencord install
venpm config set vencord.path ~/Vencord
# Add a plugin repository
venpm repo add https://example.com/plugins.json
# Find and install plugins
venpm search betterFolders
venpm install BetterFolders
venpm list
venpm update
venpm rebuild| Command | Description |
|---|---|
venpm install <plugin> |
Install a plugin and its dependencies |
venpm uninstall <plugin> |
Remove a plugin (warns about reverse deps) |
venpm update [plugin] |
Update one or all plugins |
venpm list |
Show installed plugins |
venpm search <query> |
Search across all configured repos |
venpm info <plugin> |
Show plugin details |
venpm repo add|remove|list |
Manage plugin index repositories |
venpm config set|get|path |
View or edit venpm configuration |
venpm create <path> |
Scaffold a new plugin repo or plugin |
venpm rebuild |
Rebuild Vencord after changes |
venpm doctor |
Diagnose environment issues |
venpm validate [path] |
Validate a plugins.json index file |
Global flags: --yes (auto-confirm), --verbose, --quiet, --json (structured output)
Author User
------ ----
plugins.json ──publish──> venpm repo add <url>
| |
v v
GitHub / any URL venpm install <plugin>
|
resolve deps
fetch (git sparse checkout / tarball)
update lockfile
rebuild Vencord
- Authors publish a
plugins.jsonindex file — a JSON document describing their plugins, versions, and sources. - Users register that URL with
venpm repo add. - venpm resolves the full dependency graph, fetches via git (with sparse checkout for monorepos) or tarball, updates the lockfile, and optionally rebuilds Vencord.
# Scaffold a new plugin repository
venpm create my-plugins
# Scaffold a plugin inside an existing repo
venpm create my-plugins/MyPlugin
# Validate your index before publishing
venpm validate plugins.json --strictvenpm ships a GitHub Action for automated index publishing:
- uses: theokyr/venpm/actions/publish-index@mainSee the Author Guide for the full walkthrough.
The JSON Schema defines the index format. Key features:
- Dependencies & optional dependencies with automatic resolution
- Monorepo support via
source.git+source.path(sparse checkout) - Multiple source types: git, tarball, local symlink
- Version pinning with
versionsmap of tag/tarball pairs - Informational constraints for Discord and Vencord versions
src/
core/ Pure logic + I/O interfaces (never imports from cli/)
types.ts All interfaces: IOContext, PluginIndex, Config, Lockfile
resolver.ts Version resolution, dependency graph, topological sort
registry.ts Fetch + parse + cache plugin indexes
fetcher.ts Git clone (sparse checkout), tarball extract, local symlink
builder.ts Vencord pnpm build, deploy, Discord restart
... config, lockfile, schema, detect, cache, paths, prompt, log
cli/ Command handlers (compose core modules)
context.ts createRealIOContext() — wires real Node.js I/O
install.ts uninstall.ts update.ts list.ts search.ts ...
index.ts CLI entry point (commander)
schemas/v1/ JSON Schemas — the primary deliverable
actions/ GitHub Action for plugin repo authors
Design principle: All I/O is injected via IOContext — filesystem, HTTP, git, shell, prompts, logging. Core modules never import fs, fetch, or child_process directly. This makes the entire core testable with pure mocks.
git clone https://github.com/theokyr/venpm.git && cd venpm
node scripts/setup.mjs # install, build, link globallynpm run dev # watch mode (live global updates)
npm test # 389 tests
npm run lint # type check (tsc --noEmit)
npm run build # one-shot compile389 tests across three layers:
| Layer | What it tests |
|---|---|
| Unit | Pure functions — resolver, registry, config, lockfile, schema, detect, cache |
| Integration | Full command flows with mocked IOContext |
| E2E | Compiled CLI as a subprocess against real temp directories |
See CONTRIBUTING.md for development guidelines.
venpm stores configuration in a single XDG-compliant directory:
| OS | Path |
|---|---|
| Linux | ~/.config/venpm/ |
| macOS | ~/Library/Application Support/venpm/ |
| Windows | %APPDATA%\venpm\ |
Files: config.json, venpm-lock.json, index-cache.json
Full documentation at venpm.dev — guides, author documentation, API reference, and TypeDoc-generated internals.
venpm is not affiliated with, endorsed by, or sponsored by Discord Inc. or the Vencord project. "Discord" is a trademark of Discord Inc., mentioned solely for descriptive purposes.
Client modifications — including Vencord and any plugins installed through venpm — are against Discord's Terms of Service. While no widespread bans for client mod usage are known, Discord may take action against accounts at any time. You use client modifications entirely at your own risk.
venpm does not review or audit third-party plugins. You are responsible for evaluating the trustworthiness of any plugin repository and plugin you install. The authors are not responsible for any damage to your Discord account, computer, or data.
This software is provided "as is", without warranty of any kind. See LICENSE for details.