@highlightxyz/cli 0.3.1 → 0.3.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.
Files changed (3) hide show
  1. package/README.md +14 -6
  2. package/lib/index.js +193 -2856
  3. package/package.json +7 -9
package/README.md CHANGED
@@ -38,7 +38,9 @@ hl chains list --testnet
38
38
 
39
39
  ## Authenticate
40
40
 
41
- Create an API key in Highlight, then save and verify it:
41
+ Sign in on Highlight, open [Settings](https://highlight.xyz/user/settings),
42
+ and choose **Create API key** under **API keys**. Copy the key shown once,
43
+ then save and verify it:
42
44
 
43
45
  ```sh
44
46
  hl auth login
@@ -84,8 +86,8 @@ hl gates create --input gate.json
84
86
  hl gates update <gate-id> --input gate-update.json
85
87
  hl gates delete <gate-id>
86
88
 
87
- hl media upload ./art.png
88
- hl media upload ./generative-code.zip --kind directory
89
+ hl media upload ./art.png --purpose CollectionLogo --collection <highlight-id>
90
+ hl media upload ./generative-code.zip --purpose GenerativeCode --collection <highlight-id>
89
91
  hl media get <media-id>
90
92
  hl media publish <media-id>
91
93
 
@@ -115,7 +117,7 @@ Collection, sale, and gate writes accept JSON with `--input <file>`. Use
115
117
 
116
118
  ## Current boundaries
117
119
 
118
- `hl collections create` creates the base draft. Version `0.1.0` does not
120
+ `hl collections create` creates the base draft. The current release does not
119
121
  configure edition, series, or generative details, so complete those fields in
120
122
  the dashboard, SDK, or REST API before deployment.
121
123
 
@@ -133,7 +135,7 @@ Pass `--json` anywhere in a command for machine-readable output:
133
135
 
134
136
  ```sh
135
137
  hl collections list --json
136
- hl media upload ./art.png --json
138
+ hl media upload ./art.png --purpose CollectionLogo --collection <highlight-id> --json
137
139
  ```
138
140
 
139
141
  Successful JSON goes to stdout. Errors go to stderr. Commands return:
@@ -145,5 +147,11 @@ Successful JSON goes to stdout. Errors go to stderr. Commands return:
145
147
  Pin the package version in production automation:
146
148
 
147
149
  ```sh
148
- npm install --global @highlightxyz/cli@0.1.0
150
+ npm install --global @highlightxyz/cli@0.3.3
149
151
  ```
152
+
153
+ ## Support
154
+
155
+ See [developer support](https://docs.highlight.xyz/reference/support/) for
156
+ troubleshooting and how to report a problem. Never include credentials in a
157
+ support request.