@magicpages/ghost-typesense-cli 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -11,6 +11,8 @@ npm install -g @magicpages/ghost-typesense-cli
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
13
|
1. Create `ghost-typesense.config.json`:
|
|
14
|
+
|
|
15
|
+
Minimal configuration:
|
|
14
16
|
```json
|
|
15
17
|
{
|
|
16
18
|
"ghost": {
|
|
@@ -32,6 +34,26 @@ npm install -g @magicpages/ghost-typesense-cli
|
|
|
32
34
|
}
|
|
33
35
|
```
|
|
34
36
|
|
|
37
|
+
The tool comes with default field configurations optimized for Ghost CMS. These include:
|
|
38
|
+
- Required fields: `id`, `title`, `url`, `slug`, `html`, `excerpt`, `published_at`, `updated_at`
|
|
39
|
+
- Optional fields: `feature_image`, `tags`, `authors`
|
|
40
|
+
|
|
41
|
+
You can override or add additional fields by specifying them in the config:
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"collection": {
|
|
46
|
+
"name": "ghost",
|
|
47
|
+
"fields": [
|
|
48
|
+
{ "name": "title", "type": "string", "index": true, "sort": true },
|
|
49
|
+
{ "name": "custom_field", "type": "string", "optional": true }
|
|
50
|
+
]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The tool will ensure all required fields are present with correct types while keeping your custom fields.
|
|
56
|
+
|
|
35
57
|
2. Available commands:
|
|
36
58
|
|
|
37
59
|
```bash
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@magicpages/ghost-typesense-cli",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.1",
|
|
4
4
|
"description": "CLI tool for managing Ghost content in Typesense",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
"typecheck": "tsc --noEmit"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@magicpages/ghost-typesense-config": "
|
|
23
|
-
"@magicpages/ghost-typesense-core": "
|
|
22
|
+
"@magicpages/ghost-typesense-config": "^1.3.1",
|
|
23
|
+
"@magicpages/ghost-typesense-core": "^1.3.1",
|
|
24
24
|
"commander": "^12.0.0",
|
|
25
25
|
"ora": "^8.0.1",
|
|
26
26
|
"chalk": "^5.3.0"
|