@uxland/harmonix-cli 0.0.4 → 0.0.6
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 +29 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @uxland/harmonix-cli
|
|
2
|
+
|
|
3
|
+
The [Harmonix](https://harmonixframework.dev) command-line tool. Its command, `harmonix publish`, uploads a built plugin to a Plugin Store. It does not build the plugin or change its version: run your build first and set `version` in `package.json` yourself.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install --save-dev @uxland/harmonix-cli
|
|
7
|
+
npm run build
|
|
8
|
+
npx harmonix publish
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Run it from the plugin folder. From its `package.json` it reads `name` (the plugin id), `version` and `module` (the built file to upload).
|
|
12
|
+
|
|
13
|
+
## Configuration
|
|
14
|
+
|
|
15
|
+
The registry URL and the API key go in a `.harmonixrc` file, in the plugin folder or any folder above it (one at the root of a monorepo works for all its plugins), or in your home folder:
|
|
16
|
+
|
|
17
|
+
```ini
|
|
18
|
+
registry=https://your-plugin-store.example.com/upload
|
|
19
|
+
apiKey=your-api-key
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The `--registry` and `--api-key` options override the file.
|
|
23
|
+
|
|
24
|
+
> `.harmonixrc` contains credentials: never commit it. Projects made with `npm create @uxland/harmonix-plugin@latest` already ignore it.
|
|
25
|
+
|
|
26
|
+
## Documentation
|
|
27
|
+
|
|
28
|
+
- [This package](https://harmonixframework.dev/docs/packages/cli/): configuration order, the request it sends, errors and exit codes.
|
|
29
|
+
- [Build and publish a plugin](https://harmonixframework.dev/docs/create-plugin/build-and-publish/).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uxland/harmonix-cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"bin": {
|
|
5
5
|
"harmonix": "index.js"
|
|
6
6
|
},
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
"index.js"
|
|
9
9
|
],
|
|
10
10
|
"main": "index.js",
|
|
11
|
-
"description": "
|
|
11
|
+
"description": "The Harmonix command-line tool: publishes a built plugin to a Plugin Store.",
|
|
12
|
+
"homepage": "https://harmonixframework.dev/docs/packages/cli/",
|
|
12
13
|
"author": "Cristian Payet <cpayet@uxland.cat>",
|
|
13
14
|
"publishConfig": {
|
|
14
15
|
"access": "public"
|
|
@@ -19,7 +20,7 @@
|
|
|
19
20
|
"harmonix"
|
|
20
21
|
],
|
|
21
22
|
"dependencies": {
|
|
22
|
-
"axios": "^1.
|
|
23
|
+
"axios": "^1.12.2",
|
|
23
24
|
"commander": "^9.4.0",
|
|
24
25
|
"form-data": "^4.0.0"
|
|
25
26
|
}
|