schornai 0.0.0-stage → 0.0.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 +43 -2
- package/bin/schornai.js +10 -0
- package/package.json +22 -4
package/README.md
CHANGED
|
@@ -1,3 +1,44 @@
|
|
|
1
|
-
#
|
|
1
|
+
# schornai
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The schorn.ai CLI is coming soon!
|
|
4
|
+
|
|
5
|
+
[Sign up for our newsletter](https://schorn.ai/newsletter) to be the first to know.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
Once published to npm, run with Node.js 22 or later:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npx schornai
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This initial release displays a coming-soon message and the newsletter link.
|
|
16
|
+
It does not require a schorn.ai account or configure your machine.
|
|
17
|
+
|
|
18
|
+
## Local development
|
|
19
|
+
|
|
20
|
+
From the repository root:
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
npm start --workspace apps/cli
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The CLI has no dependencies or build step.
|
|
27
|
+
|
|
28
|
+
## Publishing
|
|
29
|
+
|
|
30
|
+
The npm package name is `schornai`; the executable is also `schornai`.
|
|
31
|
+
The name is only reserved after the first successful publication.
|
|
32
|
+
|
|
33
|
+
From the repository root, review the package contents and publish using an
|
|
34
|
+
authorized npm account (complete npm's authentication or 2FA prompt if requested):
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
npm pack --workspace apps/cli --dry-run
|
|
38
|
+
npm login --registry=https://registry.npmjs.org/
|
|
39
|
+
npm publish --workspace apps/cli
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Only the executable, package metadata, and this README are included in the package.
|
|
43
|
+
For later releases, increase the version in `apps/cli/package.json` and update the
|
|
44
|
+
root lockfile before publishing again.
|
package/bin/schornai.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "schornai",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "The schorn.ai CLI — coming soon.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"schornai": "bin/schornai.js"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"bin/"
|
|
11
|
+
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"start": "node bin/schornai.js"
|
|
14
|
+
},
|
|
15
|
+
"engines": {
|
|
16
|
+
"node": ">=22"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://schorn.ai",
|
|
19
|
+
"license": "UNLICENSED",
|
|
20
|
+
"publishConfig": {
|
|
21
|
+
"access": "public",
|
|
22
|
+
"registry": "https://registry.npmjs.org/"
|
|
23
|
+
}
|
|
24
|
+
}
|