|
7 | 7 | | Field | Detail | |
8 | 8 | | --- | --- | |
9 | 9 | | **Name:** | Contentstack CLI plugins (pnpm monorepo; root package name `csdx`) | |
10 | | -| **Purpose:** | OCLIF plugins that extend the Contentstack CLI (import/export, clone, migration, seed, audit, variants, etc.). | |
| 10 | +| **Purpose:** | OCLIF plugins that extend the Contentstack CLI (import/export, clone, migration, migrate RTE, bulk operations, seed, audit, variants, Developer Hub apps, TypeScript codegen, etc.). | |
11 | 11 | | **Out of scope (if any):** | The **core** CLI aggregation lives in the separate `cli` monorepo; this repo ships plugin packages only. | |
12 | 12 |
|
13 | 13 | ## Tech stack (at a glance) |
@@ -35,11 +35,60 @@ CI: [.github/workflows/unit-test.yml](.github/workflows/unit-test.yml) and other |
35 | 35 | | Skill | Path | What it covers | |
36 | 36 | | --- | --- | --- | |
37 | 37 | | Development workflow | [skills/dev-workflow/SKILL.md](skills/dev-workflow/SKILL.md) | pnpm commands, CI, TDD expectations, PR checklist | |
38 | | -| Contentstack CLI | [skills/contentstack-cli/SKILL.md](skills/contentstack-cli/SKILL.md) | Plugin commands, OCLIF, Contentstack APIs | |
39 | | -| Framework | [skills/framework/SKILL.md](skills/framework/SKILL.md) | Utilities, config, logging, errors | |
| 38 | +| Contentstack CLI | [skills/contentstack-cli/SKILL.md](skills/contentstack-cli/SKILL.md) | Plugin commands, OCLIF, Contentstack APIs (incl. `app:*` / `@contentstack/apps-cli`) | |
| 39 | +| Framework | [skills/framework/SKILL.md](skills/framework/SKILL.md) | Utilities, config, logging, errors (incl. Developer Hub SDK, manifests, GraphQL) | |
40 | 40 | | Testing | [skills/testing/SKILL.md](skills/testing/SKILL.md) | Mocha/Chai, coverage, mocks | |
41 | 41 | | Code review | [skills/code-review/SKILL.md](skills/code-review/SKILL.md) | PR review for this monorepo | |
42 | 42 |
|
| 43 | +## Apps CLI plugin (`@contentstack/apps-cli`) |
| 44 | + |
| 45 | +- **Package path:** [packages/contentstack-apps-cli](packages/contentstack-apps-cli) |
| 46 | +- **npm name:** `@contentstack/apps-cli` (unchanged for consumers) |
| 47 | +- **Migrated from:** [contentstack/contentstack-apps-cli](https://github.com/contentstack/contentstack-apps-cli) — see [APPS-CLI-MIGRATION.md](APPS-CLI-MIGRATION.md) |
| 48 | +- **v1 / v2:** Maintain on `v1-dev` (1.x CLI deps) and `v2-dev` / `v2-beta` (2.x beta deps) branches; align `@contentstack/cli-command` and `@contentstack/cli-utilities` versions with the target CLI line. |
| 49 | +- **Docs:** OCLIF / `app:*` commands → [contentstack-cli](skills/contentstack-cli/SKILL.md#apps-cli-commands-app); SDK, manifests, GraphQL, HTTP → [framework](skills/framework/SKILL.md#apps-cli-plugin-contentstackapps-cli) |
| 50 | + |
| 51 | +## Tsgen plugin (`contentstack-cli-tsgen`) |
| 52 | + |
| 53 | +- **Package path:** [packages/contentstack-cli-tsgen](packages/contentstack-cli-tsgen) |
| 54 | +- **npm name:** `contentstack-cli-tsgen` (unchanged for consumers) |
| 55 | +- **Migrated from:** standalone `contentstack-cli-tsgen` repos — see [TSGEN-MIGRATION.md](TSGEN-MIGRATION.md) |
| 56 | +- **v2 beta only:** `5.0.0-beta.0`+ on `feat/migrate-external-cli-plugins-v2` / `v2-beta`; requires CLI 2.x beta. |
| 57 | +- **Docs:** `csdx tsgen` → [typescript-cli-tsgen](packages/contentstack-cli-tsgen/skills/typescript-cli-tsgen/SKILL.md); tests → [package testing skill](packages/contentstack-cli-tsgen/skills/testing/SKILL.md) |
| 58 | + |
| 59 | +## Content Type plugin (`contentstack-cli-content-type`) |
| 60 | + |
| 61 | +- **Package path:** [packages/contentstack-content-type](packages/contentstack-content-type) |
| 62 | +- **npm name:** `contentstack-cli-content-type` |
| 63 | +- **Migrated from:** [contentstack/contentstack-cli-content-type](https://github.com/contentstack/contentstack-cli-content-type) — see [CONTENT-TYPE-MIGRATION.md](CONTENT-TYPE-MIGRATION.md) |
| 64 | +- **v1 / v2:** Maintain on `v1-dev` / `main` (1.x CLI deps) and `v2-beta` (2.x beta deps) branches; align `@contentstack/cli-command` and `@contentstack/cli-utilities` versions with the target CLI line. |
| 65 | +- **Tests:** Jest + ts-jest (unlike most other packages which use Mocha + Chai) |
| 66 | +- **Docs:** 6 commands under `content-type:*` → [packages/contentstack-content-type/AGENTS.md](packages/contentstack-content-type/AGENTS.md) |
| 67 | + |
| 68 | +## Regex Validate plugin (`@contentstack/cli-cm-regex-validate`) |
| 69 | + |
| 70 | +- **Package path:** [packages/contentstack-cli-cm-regex-validate](packages/contentstack-cli-cm-regex-validate) |
| 71 | +- **npm name:** `@contentstack/cli-cm-regex-validate` |
| 72 | +- **Migrated from:** [contentstack/cli-cm-regex-validate](https://github.com/contentstack/cli-cm-regex-validate) — see [REGEX-VALIDATE-MIGRATION.md](REGEX-VALIDATE-MIGRATION.md) |
| 73 | +- **v1 / v2:** Maintain on `v1-dev` / `main` (v1 CLI deps) and `v2-beta` (`~2.0.0-beta.7` / `~2.0.0-beta.8`, version `2.0.0-beta.0`); align with target CLI line. |
| 74 | +- **Tests:** Jest + ts-jest (unlike most other packages which use Mocha + Chai) |
| 75 | +- **Command:** Single command `cm:stacks:validate-regex` (short name `RGXVLD`) |
| 76 | +- **Docs:** [packages/contentstack-cli-cm-regex-validate/AGENTS.md](packages/contentstack-cli-cm-regex-validate/AGENTS.md) |
| 77 | + |
| 78 | +## Migrate RTE plugin (`@contentstack/cli-cm-migrate-rte`) |
| 79 | + |
| 80 | +- **Package path:** [packages/contentstack-migrate-rte](packages/contentstack-migrate-rte) |
| 81 | +- **npm name:** `@contentstack/cli-cm-migrate-rte` (unchanged) |
| 82 | +- **Migrated from:** [contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli-cm-migrate-rte) — see [MIGRATE-RTE-MIGRATION.md](MIGRATE-RTE-MIGRATION.md) |
| 83 | +- **Command:** `csdx cm:entries:migrate-html-rte` — JS sources in `src/`; `pnpm --filter @contentstack/cli-cm-migrate-rte run build` (`oclif manifest`) and `test` (see [dev-workflow](skills/dev-workflow/SKILL.md)) |
| 84 | + |
| 85 | +## Bulk operations plugin (`@contentstack/cli-bulk-operations`) |
| 86 | + |
| 87 | +- **Package path:** [packages/contentstack-bulk-operations](packages/contentstack-bulk-operations) |
| 88 | +- **npm name:** `@contentstack/cli-bulk-operations` (unchanged) |
| 89 | +- **Migrated from:** [contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations) — see [BULK-OPERATIONS-MIGRATION.md](BULK-OPERATIONS-MIGRATION.md) (commands + repository) |
| 90 | +- **Commands:** `csdx cm:stacks:bulk-entries`, `csdx cm:stacks:bulk-assets`, `csdx cm:stacks:bulk-taxonomies` — see [dev-workflow](skills/dev-workflow/SKILL.md) |
| 91 | + |
43 | 92 | ## Using Cursor (optional) |
44 | 93 |
|
45 | 94 | If you use **Cursor**, [.cursor/rules/README.md](.cursor/rules/README.md) only points to **`AGENTS.md`**—same docs as everyone else. |
0 commit comments