Overview
Summary generated from the READMEA global command-line tool for working with Payload CMS projects. It can initialize a project, add, update, list and remove plugins, and generate new collections. It also offers interactive menus and a config file for project settings.
Features
- Initialize a Payload project from the command line
- Add, update and remove plugins by name
- List available plugins
- Generate new collection files
- Interactive help menu for navigation
- Create a CLI configuration file for the project
Use cases
- Install and manage Payload plugins from the terminal without editing config by hand
- Scaffold new collections quickly while building a Payload project
From the author
CLI tool for PayloadCMS plugins
Installation
npm i @payloadcmsdirectory/cli4
Stars
0
Forks
0
Open Issues
1 years ago
Last Updated
0
Weekly Downloads
v0.2.38
npm Version
169.8 KB
Unpacked Size
12
Dependencies
Trends (last 90 days)
Trends appear after 7 days of data. Daily snapshots have not started yet.
Trends appear after 7 days of data. Daily snapshots have not started yet.
Each point is npm's rolling 7-day download count.
Health Score
Composite score based on GitHub activity, stars, npm downloads, publish recency, dependency count, and package size.
Badge for your README
[](https://payloaddirectory.dev/plugins/955399119-root)<a href="https://payloaddirectory.dev/plugins/955399119-root"><img src="https://payloaddirectory.dev/badge/955399119-root.svg" alt="Payload Directory"></a>README
PayloadCMS Directory CLI
A command-line interface tool for managing PayloadCMS plugins and configurations.
Features
- 🚀 Initialize PayloadCMS projects
- 📦 Install and manage plugins
- 🔨 Generate collections and configurations
- 🎯 Interactive menus for easy navigation
- ⚙️ Project configuration management
Installation
npm install -g @payloadcmsdirectory/cli
# or
yarn global add @payloadcmsdirectory/cli
# or
pnpm add -g @payloadcmsdirectory/cli
Usage
Run the CLI:
payloadcli
Or use it directly with npx:
npx @payloadcmsdirectory/cli
Commands
init- Initialize a PayloadCMS projectadd [plugin]- Add a plugin to your projectlist- List available pluginsupdate [plugin]- Update an installed pluginremove [plugin]- Remove an installed plugingenerate:collection [name]- Generate a new collectioninit:config- Initialize PayloadCLI config filehelp- Show interactive help menu
Contributing
Please read our Contributing Guide before submitting a Pull Request to the project.
Support
License
MIT © PayloadCMS Directory
Similar plugins
payload plugin tooling
Shared lint, format, TypeScript, build, test and CI config for building Payload plugins
650/wk0v4
payload utilities
Developer helpers for Payload: document traversal, flattening, transformation and fully populated type generation
610/wk15v3
payload schema
Define Payload field validation once and reuse it as Payload fields and Zod schemas
570/wk2v3
payload cli
Command-line access to Payload collections and globals through the Local API, aimed at AI agents and developers
570/wk13v3
payload dev tools
Floating dev toolbar, /dev pages and an app snapshot for AI agents in Payload projects on Next.js
560/wk18v3
payload field factories
Typed factory functions for writing Payload field configs more concisely
502/wk0v3