@pixzle/cli 0.1.6 → 0.1.7
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 +14 -11
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -12,20 +12,20 @@ npm install @pixzle/cli
|
|
|
12
12
|
|
|
13
13
|
### Shuffle
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Fragments images into blocks and shuffles them.
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
pixzle shuffle <images...> -o <output_directory> [options]
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
| Option | Description | Default |
|
|
22
|
-
|
|
23
|
-
| `-o, --output <dir>` | Output directory (Required) | - |
|
|
24
|
-
| `-b, --block-size <number>` | Pixel block size | 8 |
|
|
25
|
-
| `-p, --prefix <prefix>` | Prefix for fragment files | "img" |
|
|
26
|
-
| `-s, --seed <seed>` | Random seed | auto |
|
|
27
|
-
| `--preserve-name` | Preserve original file names | false |
|
|
28
|
-
| `--cross-image-shuffle` | Shuffle blocks across all images | false |
|
|
21
|
+
| Option | Description | Required | Default |
|
|
22
|
+
|--------|-------------|:---------:|---------|
|
|
23
|
+
| `-o, --output <dir>` | Output directory (Required) | ✅ | - |
|
|
24
|
+
| `-b, --block-size <number>` | Pixel block size | ー | 8 |
|
|
25
|
+
| `-p, --prefix <prefix>` | Prefix for fragment files | ー | "img" |
|
|
26
|
+
| `-s, --seed <seed>` | Random seed | ー | auto |
|
|
27
|
+
| `--preserve-name` | Preserve original file names | ー | false |
|
|
28
|
+
| `--cross-image-shuffle` | Shuffle blocks across all images | ー | false |
|
|
29
29
|
|
|
30
30
|
**Example:**
|
|
31
31
|
```bash
|
|
@@ -48,6 +48,7 @@ With `--cross-image-shuffle`, blocks are mixed across all input images, rather t
|
|
|
48
48
|
> - Currently, restoration with --cross-image-shuffle is only supported in Node.js and CLI environments.
|
|
49
49
|
> - May cause memory shortage depending on the number of images and block size.
|
|
50
50
|
|
|
51
|
+
----
|
|
51
52
|
|
|
52
53
|
### Restore
|
|
53
54
|
|
|
@@ -60,7 +61,7 @@ pixzle restore <fragments...> -m <manifest_path> -o <output_directory>
|
|
|
60
61
|
```
|
|
61
62
|
|
|
62
63
|
| Option | Description | Required |
|
|
63
|
-
|
|
64
|
+
|--------|-------------|:----------:|
|
|
64
65
|
| `-m, --manifest <path>` | Path to manifest.json | ✅ |
|
|
65
66
|
| `-o, --output <dir>` | Output directory | ✅ |
|
|
66
67
|
|
|
@@ -69,6 +70,8 @@ pixzle restore <fragments...> -m <manifest_path> -o <output_directory>
|
|
|
69
70
|
pixzle restore ./output/*.png -m ./output/manifest.json -o ./restored
|
|
70
71
|
```
|
|
71
72
|
|
|
73
|
+
----
|
|
74
|
+
|
|
72
75
|
#### Manual Configuration (Single Image)
|
|
73
76
|
|
|
74
77
|
Restore a single image without a manifest file.
|
|
@@ -78,7 +81,7 @@ pixzle restore <fragment> -o <output_directory> -b <size> -s <seed> -w <width> -
|
|
|
78
81
|
```
|
|
79
82
|
|
|
80
83
|
| Option | Description | Required |
|
|
81
|
-
|
|
84
|
+
|--------|-------------|:----------:|
|
|
82
85
|
| `-o, --output <dir>` | Output directory | ✅ |
|
|
83
86
|
| `-b, --block-size <number>` | Pixel block size | ✅ |
|
|
84
87
|
| `-s, --seed <number>` | Random seed | ✅ |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pixzle/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.7",
|
|
4
4
|
"description": "CLI implementation of image fragmentation and restoration",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"commander": "^12.1.0",
|
|
36
|
-
"@pixzle/core": "0.1.
|
|
37
|
-
"@pixzle/node": "0.1.
|
|
36
|
+
"@pixzle/core": "0.1.7",
|
|
37
|
+
"@pixzle/node": "0.1.7"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@types/node": "^22.10.1",
|