jwk-cli-tool 1.0.0 → 1.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.
Files changed (2) hide show
  1. package/README.md +38 -30
  2. package/package.json +21 -21
package/README.md CHANGED
@@ -1,33 +1,41 @@
1
- # JWK CLI Tool
2
-
3
- Simple interactive CLI to generate:
4
- - PEM key pairs (`.private.pem`, `.public.pem`)
5
- - JWK JSON files (`.private.jwk.json`, `.public.jwk.json`)
6
-
7
- ## Requirements
8
-
9
- - Node.js 18 or newer
10
- - npm
11
-
12
- ## Install
13
-
14
- ```bash
15
- npm install
16
- ```
17
-
18
- ## Run
19
-
20
- ### Development mode
21
-
22
- ```bash
23
- npm run dev
24
- ```
25
-
26
- ### Production mode
27
-
28
- ```bash
29
- npm run build
30
- npm start
1
+ # JWK CLI Tool
2
+
3
+ Simple interactive CLI to generate:
4
+ - PEM key pairs (`.private.pem`, `.public.pem`)
5
+ - JWK JSON files (`.private.jwk.json`, `.public.jwk.json`)
6
+
7
+ ## Quick Start (No Install)
8
+
9
+ Run directly with `npx`:
10
+
11
+ ```bash
12
+ npx jwk-cli-tool
13
+ ```
14
+
15
+ For `npx` mode:
16
+ - CLI asks where to save generated files
17
+ - Default base folder is `./jwk`
18
+ - Files are saved in `<base>/keys` and `<base>/outputs`
19
+
20
+ ## Requirements
21
+
22
+ - Node.js 18 or newer
23
+ - npm
24
+
25
+ ## Run Locally (Download Version)
26
+
27
+ If you want to run from cloned source:
28
+
29
+ ```bash
30
+ npm install
31
+ npm run dev
32
+ ```
33
+
34
+ Or build + start:
35
+
36
+ ```bash
37
+ npm run build
38
+ npm start
31
39
  ```
32
40
 
33
41
  ## How to use
package/package.json CHANGED
@@ -1,25 +1,25 @@
1
1
  {
2
- "name": "jwk-cli-tool",
3
- "version": "1.0.0",
4
- "description": "Interactive CLI for generating PEM and JWK files",
5
- "main": "dist/index.js",
6
- "bin": {
7
- "jwk-cli-tool": "dist/npx.js"
8
- },
9
- "files": [
10
- "dist"
11
- ],
12
- "engines": {
13
- "node": ">=18"
14
- },
15
- "scripts": {
16
- "dev": "ts-node src/index.ts",
17
- "build": "tsc",
18
- "start": "node dist/index.js",
19
- "test": "vitest run",
20
- "test:watch": "vitest",
21
- "prepublishOnly": "npm run build"
22
- },
2
+ "name": "jwk-cli-tool",
3
+ "version": "1.0.1",
4
+ "description": "Interactive CLI for generating PEM and JWK files",
5
+ "main": "dist/index.js",
6
+ "bin": {
7
+ "jwk-cli-tool": "dist/npx.js"
8
+ },
9
+ "files": [
10
+ "dist"
11
+ ],
12
+ "engines": {
13
+ "node": ">=18"
14
+ },
15
+ "scripts": {
16
+ "dev": "ts-node src/index.ts",
17
+ "build": "tsc",
18
+ "start": "node dist/index.js",
19
+ "test": "vitest run",
20
+ "test:watch": "vitest",
21
+ "prepublishOnly": "npm run build"
22
+ },
23
23
  "keywords": [
24
24
  "cli",
25
25
  "jwk",