aemdm 0.1.0 → 0.1.3
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 +25 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,27 +23,24 @@ It is designed as a practical operator tool for both humans and LLM-driven workf
|
|
|
23
23
|
|
|
24
24
|
## Install
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
npm install
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
Install the CLI globally from npm:
|
|
26
|
+
Install globally from npm:
|
|
31
27
|
|
|
32
28
|
```bash
|
|
33
29
|
npm install -g aemdm
|
|
34
30
|
```
|
|
35
31
|
|
|
36
|
-
|
|
32
|
+
Or run directly with `npx`:
|
|
37
33
|
|
|
38
34
|
```bash
|
|
39
|
-
|
|
40
|
-
node dist/cli.js asset get urn:aaid:aem:1234 --bucket delivery-p123-e456.adobeaemcloud.com
|
|
35
|
+
npx aemdm asset get urn:aaid:aem:1234 --bucket delivery-p123-e456.adobeaemcloud.com
|
|
41
36
|
```
|
|
42
37
|
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
43
40
|
### URL by asset ID
|
|
44
41
|
|
|
45
42
|
```bash
|
|
46
|
-
|
|
43
|
+
npx aemdm asset get urn:aaid:aem:1234 \
|
|
47
44
|
--bucket delivery-p123-e456.adobeaemcloud.com \
|
|
48
45
|
--format webp \
|
|
49
46
|
--size 1200x800 \
|
|
@@ -53,19 +50,19 @@ node dist/cli.js asset get urn:aaid:aem:1234 \
|
|
|
53
50
|
### Metadata
|
|
54
51
|
|
|
55
52
|
```bash
|
|
56
|
-
|
|
53
|
+
npx aemdm asset get urn:aaid:aem:1234 --metadata
|
|
57
54
|
```
|
|
58
55
|
|
|
59
56
|
If an IMS token is available, `--metadata` returns the full metadata document from the metadata endpoint. Without authentication, it returns a smaller public JSON object based on the asset response headers:
|
|
60
57
|
|
|
61
58
|
```bash
|
|
62
|
-
|
|
59
|
+
npx aemdm asset get urn:aaid:aem:1234 --metadata --ims-token "$AEMDM_IMS_TOKEN"
|
|
63
60
|
```
|
|
64
61
|
|
|
65
62
|
### Original binary
|
|
66
63
|
|
|
67
64
|
```bash
|
|
68
|
-
|
|
65
|
+
npx aemdm asset get urn:aaid:aem:1234 \
|
|
69
66
|
--original \
|
|
70
67
|
--binary \
|
|
71
68
|
--output ./asset.bin
|
|
@@ -74,13 +71,13 @@ node dist/cli.js asset get urn:aaid:aem:1234 \
|
|
|
74
71
|
Public assets can also be downloaded without passing a token:
|
|
75
72
|
|
|
76
73
|
```bash
|
|
77
|
-
|
|
74
|
+
npx aemdm asset get urn:aaid:aem:1234 --binary --output ./asset.bin
|
|
78
75
|
```
|
|
79
76
|
|
|
80
77
|
### Search
|
|
81
78
|
|
|
82
79
|
```bash
|
|
83
|
-
|
|
80
|
+
npx aemdm search \
|
|
84
81
|
--where x:y=z \
|
|
85
82
|
--where repositoryMetadata.dc:format=image/jpeg,image/png
|
|
86
83
|
```
|
|
@@ -90,9 +87,9 @@ node dist/cli.js search \
|
|
|
90
87
|
The default `search` output is a compact table for humans. For automation and piping, use one of these:
|
|
91
88
|
|
|
92
89
|
```bash
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
90
|
+
npx aemdm search --text "hero" --first-id
|
|
91
|
+
npx aemdm search --text "hero" --ids-only
|
|
92
|
+
npx aemdm search --text "hero" --json
|
|
96
93
|
```
|
|
97
94
|
|
|
98
95
|
These are useful when another command needs an asset ID:
|
|
@@ -113,7 +110,7 @@ aemdm search --text "hero" --json | jq -r '.hits.results[0].assetId'
|
|
|
113
110
|
Use `--skill` to print a concise guide that explains what the tool does, which commands to use, and how an LLM should choose between them.
|
|
114
111
|
|
|
115
112
|
```bash
|
|
116
|
-
|
|
113
|
+
npx aemdm --skill
|
|
117
114
|
```
|
|
118
115
|
|
|
119
116
|
Example output areas:
|
|
@@ -130,22 +127,22 @@ Example output areas:
|
|
|
130
127
|
You can save the bucket once and omit `--bucket` from later commands:
|
|
131
128
|
|
|
132
129
|
```bash
|
|
133
|
-
|
|
130
|
+
npx aemdm --bucket delivery-p123-e456.adobeaemcloud.com
|
|
134
131
|
```
|
|
135
132
|
|
|
136
133
|
After that, regular commands can use the saved profile bucket:
|
|
137
134
|
|
|
138
135
|
```bash
|
|
139
|
-
|
|
140
|
-
|
|
136
|
+
npx aemdm asset get urn:aaid:aem:1234
|
|
137
|
+
npx aemdm search --where x:y=z
|
|
141
138
|
```
|
|
142
139
|
|
|
143
140
|
### First result helpers
|
|
144
141
|
|
|
145
142
|
```bash
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
143
|
+
npx aemdm search --text "hero banner" --first-url --format webp --width 800
|
|
144
|
+
npx aemdm search --text "hero banner" --first-metadata
|
|
145
|
+
npx aemdm search --text "hero banner" --first-binary --output ./hero.bin
|
|
149
146
|
```
|
|
150
147
|
|
|
151
148
|
## Configuration
|
|
@@ -171,7 +168,7 @@ Profile config path:
|
|
|
171
168
|
These are especially useful when another tool or agent needs to understand how to call `aemdm`.
|
|
172
169
|
|
|
173
170
|
```bash
|
|
174
|
-
|
|
171
|
+
npx aemdm --skill
|
|
175
172
|
```
|
|
176
173
|
|
|
177
174
|
```bash
|
|
@@ -204,7 +201,7 @@ npm publish
|
|
|
204
201
|
|
|
205
202
|
### Automated npm publish from GitHub
|
|
206
203
|
|
|
207
|
-
The repository includes a GitHub Actions workflow that publishes to npm when you push a version tag like `v0.1.
|
|
204
|
+
The repository includes a GitHub Actions workflow that publishes to npm when you push a version tag like `v0.1.3` or publish a GitHub release for that tag.
|
|
208
205
|
|
|
209
206
|
Required setup:
|
|
210
207
|
|
|
@@ -217,8 +214,8 @@ Add `NPM_TOKEN` as a GitHub repository secret with permission to publish the `ae
|
|
|
217
214
|
Release flow:
|
|
218
215
|
|
|
219
216
|
```bash
|
|
220
|
-
git tag v0.1.
|
|
221
|
-
git push origin v0.1.
|
|
217
|
+
git tag v0.1.3
|
|
218
|
+
git push origin v0.1.3
|
|
222
219
|
```
|
|
223
220
|
|
|
224
221
|
The workflow verifies that the tag matches the `version` field in `package.json`, runs `lint`, `build`, and `test`, and then publishes the package.
|