payload-cli

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #rust #deep-learning #docker #java #windows #vue #pytorch #security #ios #openai

(★ 10)

PayloadCMS CLI for AI agents and humans. Simple, direct access to your CMS data.

payload-cli 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align='center'>
    <br/>
    <br/>
    <h3>payload-cli</h3>
    <p>PayloadCMS automation CLI for AI agents</p>
    <br/>
    <br/>
</div>

Direct database access to PayloadCMS through the Local API. No server, no API keys, no MCP. Just commands.

Built for AI coding agents (Opencode, Claude Code, etc.) but works great for humans too.

## Quick Start

```bash
cd your-payload-project
npx payload-cli collections                  # discover
npx payload-cli describe posts               # understand schema
npx payload-cli describe posts --examples    # see JSON field structures
npx payload-cli find posts --limit 5         # read
npx payload-cli create posts --data '{"title":"Hello"}' # write
```

Or point at a config directly:

```bash
npx payload-cli find posts --config ./src/payload.config.ts
```

## Commands

| Command                                      | Description                                                             |
| -------------------------------------------- | ----------------------------------------------------------------------- |
| `collections`                                | List all collections                                                    |
| `globals`                                    | List all globals                                                        |
| `describe <name> [--examples]`               | Show full schema (with sample JSON field structures)                    |
| `status`                                     | Instance status                                                         |
| `find <collection>`                          | Query documents (`--where`, `--limit`, `--sort`, `--select`, `--depth`) |
| `find-by-id <collection> <id>`               | Get a single document                                                   |
| `create <collection> --data '{...}'`         | Create a document                                                       |
| `update <collection> <id> --data '{...}'`    | Partial update                                                          |
| `update-many <collection> --where --data`    | Bulk update                                                             |
| `delete <collection> <id> --confirm`         | Delete (previews first)                                                 |
| `delete-many <collection> --where --confirm` | Bulk delete                                                             |
| `upload <collection> <file\|dir>`            | Upload file(s) to an upload collection                                  |
| `download <collection> <id\|--where>`        | Download media to disk                                                  |
| `get-global <slug>`                          | Read a global                                                           |
| `update-global <slug> --data '{...}'`        | Update a global                                                         |

## Media

Upload, download, and attach files to documents:

```bash
# Upload
payload-cli upload media ./hero.jpg --data '{"alt":"Hero image"}'
payload-cli upload media ./photos/             # bulk upload directory

# Download
payload-cli download media 6789abc --out ./downloads/
payload-cli download media --where '{"alt":{"contains":"hero"}}'

# Auto-upload and attach to a document field
payload-cli create pages --data '{"title":"About"}' --file 'heroImage=./hero.jpg'
payload-cli update pages <id> --data '{}' --file 'thumbnail=./thumb.png'
```

The `--file` flag auto-detects the target upload collection from the field schema, uploads the file, and injects the resulting ID.

## Flags

| Flag                       | Description                                                                |
| -------------------------- | -------------------------------------------------------------------------- |
| `--json`                   | Machine-readable JSON output                                               |
| `--dry-run`                | Validate without writing                                                   |
| `--confirm`                | Confirm destructive operations                                             |
| `--config <path>`          | Path to `payload.config.ts`                                                |
| `--locale <code>`          | Locale for reading/writing localized fields (use `all` to see all locales) |
| `--fallback-locale <code>` | Fallback locale for reads (use `none` to disable)                          |
| `--file 'field=./path'`    | Upload and attach file to a field                                          |
| `--data @file.json`        | Read `--data` JSON from a file instead of inline                           |
| `--examples`               | Show example values for `json` fields (use with `describe`)                |
| `--include-sensitive`      | Include password hashes, API keys, etc.                                    |

## How It Works

```
payload-cli find posts --limit 5
       |
       v
  Import your payload.config.ts
  Initialize Payload Local API
  payload.find({ collection: 'posts', limit: 5 })
  Output result
```

No HTTP server needed. Connects directly to your database through Payload's own Local API.

## Agent Skill

The `skills/` directory contains a [Claude Code skill](https://claude.ai/docs/skills) that teaches agents the discover-describe-read-write-verify workflow:

```bash
# Agents learn to:
# 1. payload-cli collections              -> what exists?
# 2. payload-cli describe posts           -> what fields?
# 3. payload-cli describe posts --examples -> what shape are json fields?
# 4. payload-cli find posts               -> what data?
# 5. payload-cli create posts --data      -> write
# 6. payload-cli find-by-id posts         -> verify
```

## Requirements

- Node.js ^18.20.2 or >=20.9.0
- Payload CMS ^3.0.0

## License

MIT

payload-cli

payload-cli 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

payload-cli

payload-cli 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README