@tandem-language-exchange/content-store 1.0.12 → 1.0.13

package/README.md

@@ -34,6 +34,33 @@ const sdk = new ContentStoreSDK({
 | `s3.secretAccessKey` | AWS IAM secret key |
 | `outputDir` | Local directory where bundle JSON files are written |
 
+### S3 config via environment variables
+
+The CLI commands (`fetch-content-bundles`, `query`) read S3 credentials automatically from the following environment variables — no code needed:
+
+| Variable | Description |
+| --- | --- |
+| `CONTENT_STORE_S3_BUCKET` | S3 bucket name |
+| `CONTENT_STORE_S3_REGION` | AWS region (default: `eu-central-1`) |
+| `AWS_ACCESS_KEY` | AWS IAM access key |
+| `AWS_SECRET_ACCESS_KEY` | AWS IAM secret key |
+
+When using the SDK class directly, pass the values explicitly as shown above. You can load them from env vars yourself:
+
+```typescript
+const sdk = new ContentStoreSDK({
+  s3: {
+    bucket: process.env.CONTENT_STORE_S3_BUCKET!,
+    region: process.env.CONTENT_STORE_S3_REGION!,
+    accessKeyId: process.env.AWS_ACCESS_KEY!,
+    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
+  },
+  outputDir: './content-cache',
+});
+```
+
+---
+
 ## `fetchBundles(options)`
 
 Downloads the latest content bundles from S3 and saves them as JSON files to `outputDir`.
@@ -62,7 +89,7 @@ const files = await sdk.fetchBundles({
 }
 ```
 
-Files are written to `outputDir` with the naming pattern `content-{cms}-{contentType}.json`.
+Files are written to `outputDir` with the naming pattern `{cms}-{contentType}.json`.
 
 ## `queryBundle(cms, contentType, options?)`
 
@@ -192,6 +219,59 @@ Query options are applied in this order:
 3. **`include`** — trim nested depth
 4. **`select`** — pick output properties
 
+## CLI
+
+The package ships two CLI entry points that can be called from npm scripts in a consuming application.
+
+### `fetch-content-bundles` — download bundles from S3
+
+Downloads the latest version of each requested content type bundle from S3 and writes them as JSON files to a local directory. Reads S3 credentials from environment variables (see [S3 config via environment variables](#s3-config-via-environment-variables)).
+
+```bash
+npx fetch-content-bundles --cms contentful --types gridLayout,page
+```
+
+| Flag | Required | Default | Description |
+| --- | --- | --- | --- |
+| `--cms <provider>` | Yes | | `contentful` or `sanity` |
+| `--types <types>` | Yes | | Comma-separated content types |
+| `--output <dir>` | No | `./content-cache` | Local directory to write bundle files to |
+
+Files are written as `{cms}-{contentType}.json` inside the output directory.
+
+**Typical use in a host app's `package.json`:**
+
+```json
+"scripts": {
+  "fetch-content": "fetch-content-bundles --cms contentful --types gridLayout,iconWithText,page --output ./content-cache"
+}
+```
+
+### `content-store query` — query a local bundle
+
+Reads a previously fetched bundle from disk and prints filtered results as JSON. Invoke via `npx` or as a local script using `node`:
+
+```bash
+npx @tandem-language-exchange/content-store query \
+  --cms contentful --type gridLayout \
+  --fields '{"columns":"2"}' \
+  --select title,bodyBefore \
+  --limit 5 \
+  --include 2
+```
+
+| Flag | Required | Default | Description |
+| --- | --- | --- | --- |
+| `--cms <provider>` | Yes | | `contentful` or `sanity` |
+| `--type <type>` | Yes | | Content type to query |
+| `--output <dir>` | No | `./content-cache` | Directory where bundles are stored |
+| `--fields <json>` | No | | JSON filter object (e.g. `'{"columns":"2"}'`) |
+| `--select <props>` | No | | Comma-separated properties to include in results |
+| `--limit <n>` | No | | Maximum number of results |
+| `--include <n>` | No | | Depth of nested references to include |
+
+---
+
 ## Standalone functions
 
 The core `fetchBundles` and `queryBundle` functions are also available as standalone imports for use outside the SDK class:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tandem-language-exchange/content-store",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",