About payload-cli
A concise reference for Payload's CLI commands used in schema workflows. It is for developers who create and run migrations, check migration status, or regenerate TypeScript types.
Key features
- 01Create schema migrations
- 02Run migrations
- 03Check migration status
- 04Regenerate TypeScript types
- 05View CLI help
Use cases
- 01Create a migration after schema changes
- 02Apply pending migrations
- 03Verify migration status
- 04Refresh types after collection changes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ timschoch/ skilly --skill payload-cliAfter installing, type/payload-cliin Claude Code to confirm it loaded.
Details
From the project READMEPayload CLI
Payload ships its own CLI (run via the repo's package scripts). Schema work goes through it, never through raw SQL.
- Create a migration after schema changes:
payload migrate:create - Run migrations:
payload migrate - Check migration status:
payload migrate:status - Regenerate TS types after collection changes:
payload generate:types - Discover more:
payload --help
Check the repo's package.json — these are usually wrapped in npm scripts.
Comments
Markdown supported