@parix/cli 0.1.5 → 0.1.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 +39 -7
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# parix
|
|
1
|
+
# @parix/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Parix command line interface. Install the npm package `@parix/cli`; the executable command is `parix`.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -9,17 +9,40 @@ npm install -g @parix/cli
|
|
|
9
9
|
parix --help
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Requirements: Node.js 20 or later.
|
|
13
|
+
|
|
14
|
+
### Migrating from `@parix/parix`
|
|
15
|
+
|
|
16
|
+
The package was renamed from `@parix/parix` to `@parix/cli`. The command name is unchanged:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm uninstall -g @parix/parix
|
|
20
|
+
npm install -g @parix/cli
|
|
21
|
+
parix --help
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Commands
|
|
25
|
+
|
|
26
|
+
Auth:
|
|
13
27
|
|
|
14
28
|
- `parix auth login`
|
|
15
29
|
- `parix auth status`
|
|
16
30
|
- `parix auth logout`
|
|
31
|
+
|
|
32
|
+
API:
|
|
33
|
+
|
|
17
34
|
- `parix api <path>`
|
|
35
|
+
|
|
36
|
+
Database:
|
|
37
|
+
|
|
18
38
|
- `parix database catalog`
|
|
19
39
|
- `parix database create <database>`
|
|
20
40
|
- `parix database list`
|
|
21
41
|
- `parix database info <database-id>`
|
|
22
42
|
- `parix database remove <database-id>`
|
|
43
|
+
|
|
44
|
+
TigerBeetle:
|
|
45
|
+
|
|
23
46
|
- `parix tb create-accounts <database-id>`
|
|
24
47
|
- `parix tb create-transfers <database-id>`
|
|
25
48
|
- `parix tb lookup-accounts <database-id>`
|
|
@@ -98,26 +121,35 @@ bun run cli -- tb create-transfers <database-id> --from 1000 --to 1001 --amount
|
|
|
98
121
|
By default, the CLI targets `https://parix.io`. You can override the target app URL with `--base-url`
|
|
99
122
|
or `PARIX_BASE_URL`.
|
|
100
123
|
|
|
124
|
+
For a global install from a local checkout:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
bun run build:link
|
|
128
|
+
parix --help
|
|
129
|
+
```
|
|
130
|
+
|
|
101
131
|
## Publishing
|
|
102
132
|
|
|
133
|
+
Package name on npm: **`@parix/cli`** (public scoped package). Binary: **`parix`**.
|
|
134
|
+
|
|
103
135
|
```bash
|
|
104
136
|
bun run publish:check
|
|
105
137
|
bun run publish:npm
|
|
106
138
|
```
|
|
107
139
|
|
|
108
|
-
`publish:check` runs formatting, linting, tests, type checking, a fresh build, and `npm pack --dry-run` using a repo-local npm cache directory. `publish:npm` publishes
|
|
140
|
+
`publish:check` runs formatting, linting, tests, type checking, a fresh build, and `npm pack --dry-run` using a repo-local npm cache directory. `publish:npm` publishes `@parix/cli` publicly to npmjs.com using that same local cache.
|
|
109
141
|
|
|
110
142
|
## GitHub Actions
|
|
111
143
|
|
|
112
144
|
- `.github/workflows/ci.yml` runs lint, tests, typecheck, build, and `npm pack --dry-run` on pushes and pull requests
|
|
113
|
-
- `.github/workflows/publish.yml` publishes to npm when a GitHub Release is published, using the `NPM_ACCESS_TOKEN` secret, and uploads the published npm tarball to the GitHub Release
|
|
145
|
+
- `.github/workflows/publish.yml` publishes `@parix/cli` to npm when a GitHub Release is published, using the `NPM_ACCESS_TOKEN` secret, and uploads the published npm tarball to the GitHub Release
|
|
114
146
|
|
|
115
147
|
Recommended release flow:
|
|
116
148
|
|
|
117
149
|
```bash
|
|
118
150
|
# bump version in package.json
|
|
119
|
-
git tag v0.1.
|
|
151
|
+
git tag v0.1.6
|
|
120
152
|
git push origin main --tags
|
|
121
153
|
```
|
|
122
154
|
|
|
123
|
-
Then publish a GitHub Release from tag `v0.1.
|
|
155
|
+
Then publish a GitHub Release from tag `v0.1.6`. The publish workflow verifies that the release tag matches `package.json`, packs the npm tarball (`parix-cli-<version>.tgz`), publishes that tarball to npm, and uploads the same `.tgz` as a GitHub Release asset.
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@parix/cli",
|
|
3
3
|
"description": "Parix command line interface",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"version": "0.1.
|
|
5
|
+
"version": "0.1.6",
|
|
6
6
|
"bin": {
|
|
7
7
|
"parix": "dist/cli.cjs"
|
|
8
8
|
},
|
|
@@ -10,20 +10,20 @@
|
|
|
10
10
|
"dist"
|
|
11
11
|
],
|
|
12
12
|
"packageManager": "bun@1.3.12",
|
|
13
|
-
"homepage": "https://github.com/
|
|
13
|
+
"homepage": "https://github.com/parixio/cli#readme",
|
|
14
14
|
"bugs": {
|
|
15
|
-
"url": "https://github.com/
|
|
15
|
+
"url": "https://github.com/parixio/cli/issues"
|
|
16
16
|
},
|
|
17
17
|
"repository": {
|
|
18
18
|
"type": "git",
|
|
19
|
-
"url": "git+https://github.com/
|
|
19
|
+
"url": "git+https://github.com/parixio/cli.git"
|
|
20
20
|
},
|
|
21
21
|
"keywords": [
|
|
22
22
|
"parix",
|
|
23
23
|
"cli",
|
|
24
|
-
"parix",
|
|
25
24
|
"database",
|
|
26
|
-
"tigerbeetle"
|
|
25
|
+
"tigerbeetle",
|
|
26
|
+
"oauth"
|
|
27
27
|
],
|
|
28
28
|
"engines": {
|
|
29
29
|
"node": ">=20"
|