Skip to content

Commit 4e040e2

Browse files
SP-874: address PR feedback on wording and package description
- Rename "batch archive" to "batch artifact" in config-commands docs - Describe overwritten, undeclared variable assignments as "ignored" - Clarify the 'config package' group description (single package) Includes-AI-Code: true Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent c01de65 commit 4e040e2

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/user-guide/config-commands.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The batch commands are **batch-specific**: they use their own archive format tha
1515

1616
## Two command families
1717

18-
The batch commands are a **self-contained, batch-specific set**. `config export` produces a multi-package **batch archive** — a top-level `manifest.json`, `variables.json`, `studio.json`, and one nested `<packageKey>_<version>.zip` per package — that is produced and consumed **only** by other batch commands. `config package import`, by contrast, works with a plain **package zip** (a `package.json`, an optional `variables.json`, and a `nodes/` folder). The two formats are **not interchangeable**:
18+
The batch commands are a **self-contained, batch-specific set**. `config export` produces a multi-package **batch artifact** — a top-level `manifest.json`, `variables.json`, `studio.json`, and one nested `<packageKey>_<version>.zip` per package — that is produced and consumed **only** by other batch commands. `config package import`, by contrast, works with a plain **package zip** (a `package.json`, an optional `variables.json`, and a `nodes/` folder). The two formats are **not interchangeable**:
1919

2020
- An archive from `config export` can be imported with `config import` or inspected with `config diff` — but **not** with `config package import`.
2121
- A package zip used by `config package import` **cannot** be imported with `config import` or diffed with `config diff`.
@@ -105,7 +105,7 @@ content-cli config list -p <sourceProfile> --packageKeys key1 ... keyN
105105

106106
## Batch Export Packages
107107

108-
> **Batch command.** Part of the [batch family](#two-command-families). It produces a multi-package **batch archive** that can only be re-imported with [`config import`](#batch-import-packages) or inspected with [`config diff`](#diff-local-zip-with-deployed-versionspecific-versionstaging)**not** with `config package import`. To work with one package, use [`config package import`](#package-commands-config-package).
108+
> **Batch command.** Part of the [batch family](#two-command-families). It produces a multi-package **batch artifact** that can only be re-imported with [`config import`](#batch-import-packages) or inspected with [`config diff`](#diff-local-zip-with-deployed-versionspecific-versionstaging)**not** with `config package import`. To work with one package, use [`config package import`](#package-commands-config-package).
109109
110110
Packages can be exported using the following command:
111111

@@ -161,7 +161,7 @@ Inside the nodes directory, a file for each node will be present:
161161

162162
## Batch Import Packages
163163

164-
> **Batch command.** Part of the [batch family](#two-command-families). It expects a multi-package **batch archive** produced by [`config export`](#batch-export-packages). To import one package from a package zip, use [`config package import`](#package-commands-config-package) instead.
164+
> **Batch command.** Part of the [batch family](#two-command-families). It expects a multi-package **batch artifact** produced by [`config export`](#batch-export-packages). To import one package from a package zip, use [`config package import`](#package-commands-config-package) instead.
165165
166166
Packages can be imported using the following commands, if importing from a zip file:
167167

@@ -215,13 +215,13 @@ content-cli config import -p <sourceProfile> -d <export_dir> --validate --overwr
215215

216216
## Package Commands (`config package`)
217217

218-
The `config package` command group works with a package and its contents. It is **not** part of the batch-specific set — it uses the plain package format described below, which is not interchangeable with the batch archive (see [Two command families](#two-command-families)).
218+
The `config package` command group works with a package and its contents. It is **not** part of the batch-specific set — it uses the plain package format described below, which is not interchangeable with the batch artifact (see [Two command families](#two-command-families)).
219219

220220
### Import a Package
221221

222-
`config package import` imports a package from a package zip (or directory). Unlike [`config import`](#batch-import-packages) — which performs a **batch** import and expects the multi-package batch archive (`manifest.json`, a top-level `variables.json`, `studio.json`, and a nested `<packageKey>_<version>.zip` per package) — `config package import` takes a plain, flat package layout and imports it on its own.
222+
`config package import` imports a package from a package zip (or directory). Unlike [`config import`](#batch-import-packages) — which performs a **batch** import and expects the multi-package batch artifact (`manifest.json`, a top-level `variables.json`, `studio.json`, and a nested `<packageKey>_<version>.zip` per package) — `config package import` takes a plain, flat package layout and imports it on its own.
223223

224-
> A zip produced by `config export` is a **batch archive** and cannot be imported with `config package import`. Likewise, a package zip cannot be imported with `config import`. Use the command that matches how the artifact was produced.
224+
> A zip produced by `config export` is a **batch artifact** and cannot be imported with `config package import`. Likewise, a package zip cannot be imported with `config import`. Use the command that matches how the artifact was produced.
225225
226226
```bash
227227
content-cli config package import -p <sourceProfile> -f <package zip file path>
@@ -253,7 +253,7 @@ package/
253253
- `package.json` is the **source of truth for variable declarations**. Every assignment in `variables.json` must reference a variable declared in `package.json`, otherwise the import is rejected.
254254
- `variables.json` is optional. If you do not want to import variable assignments, simply omit the file.
255255

256-
This is intentionally different from the batch archive: there is no `manifest.json`, no `studio.json`, and no nested per-package zips — just the one package's files at the top level.
256+
This is intentionally different from the batch artifact: there is no `manifest.json`, no `studio.json`, and no nested per-package zips — just the one package's files at the top level.
257257

258258
#### Overwriting an Existing Package
259259

@@ -263,7 +263,7 @@ By default the import fails if a package with the same key already exists. Use `
263263
content-cli config package import -p <sourceProfile> -f <file path> --overwrite
264264
```
265265

266-
When overwriting, variable assignments whose key is no longer declared in the imported `package.json` are pruned, keeping declarations and assignments consistent.
266+
When overwriting, variable assignments whose key is no longer declared in the imported `package.json` are ignored, keeping declarations and assignments consistent.
267267

268268
#### Output
269269

@@ -943,7 +943,7 @@ content-cli config nodes dependencies list --packageKey <packageKey> --nodeKey <
943943
944944
## Diff local zip with deployed version/specific version/staging
945945
946-
> **Batch command.** Part of the [batch family](#two-command-families). It expects a multi-package **batch archive** produced by [`config export`](#batch-export-packages); a package zip is not supported here.
946+
> **Batch command.** Part of the [batch family](#two-command-families). It expects a multi-package **batch artifact** produced by [`config export`](#batch-export-packages); a package zip is not supported here.
947947
948948
To compare local zipped packages with online packages use:
949949
```bash

src/commands/configuration-management/module.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class Module extends IModule {
6363
.action(this.batchImportPackages);
6464

6565
const packageCommand = configCommand.command("package")
66-
.description("Commands for working with a package.");
66+
.description("Commands for working with a single package.");
6767

6868
packageCommand.command("import")
6969
.description("Import a package from a zip file or directory. Uses the package format, which is not interchangeable with the batch 'config export' / 'config import' archive.")

0 commit comments

Comments
 (0)