imgstat 1.0.1 → 1.0.3
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/package.json +3 -2
- package/readme.md +13 -41
package/package.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "imgstat",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "Recursively rename images with dimensions so LLMs can see them.",
|
|
5
5
|
"bin": {
|
|
6
|
+
"imgstat": "./imagestat",
|
|
6
7
|
"imagestat": "./imagestat"
|
|
7
8
|
},
|
|
8
9
|
"repository": {
|
package/readme.md
CHANGED
|
@@ -1,58 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# imgstat
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/imgstat)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
|
-
**
|
|
6
|
+
**Give AI context about your images.**
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
LLMs can't see image dimensions. `imgstat` recursively scans directories and renames images to include their size (e.g., `photo.jpg` → `photo-1920x1080.jpg`), so your AI coding assistant knows exactly what it's working with.
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
- **
|
|
12
|
-
- **
|
|
13
|
-
- **
|
|
10
|
+
**Features:**
|
|
11
|
+
- **AI-Ready Context**: Embeds dimensions directly in filenames.
|
|
12
|
+
- **Idempotent**: Smartly skips images that are already renamed.
|
|
13
|
+
- **Recursive**: Handles deep directory structures.
|
|
14
14
|
|
|
15
|
-
## Installation
|
|
15
|
+
## Installation & Usage
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
The easiest way if you have Node.js installed:
|
|
17
|
+
**Install:**
|
|
19
18
|
```bash
|
|
20
19
|
npm install -g imgstat
|
|
21
20
|
```
|
|
22
|
-
*Note: Requires a bash environment (Linux, macOS, WSL, or Git Bash).*
|
|
23
21
|
|
|
24
|
-
|
|
25
|
-
One-line install from your terminal:
|
|
22
|
+
**Run:**
|
|
26
23
|
```bash
|
|
27
|
-
|
|
24
|
+
imgstat [directory]
|
|
28
25
|
```
|
|
29
26
|
|
|
30
|
-
|
|
31
|
-
If you prefer a package manager:
|
|
32
|
-
1. Download the latest `.deb` from the [Releases page](https://github.com/isaac0yen/imgstat/releases).
|
|
33
|
-
2. Install it:
|
|
34
|
-
```bash
|
|
35
|
-
sudo apt install ./imagestat_1.0_all.deb
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Option 4: Manual
|
|
39
|
-
```bash
|
|
40
|
-
git clone https://github.com/isaac0yen/imgstat.git
|
|
41
|
-
cd imgstat
|
|
42
|
-
sudo ./install.sh
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### Windows
|
|
46
|
-
1. **Recommended**: Use **WSL** (Ubuntu) and follow "Option 2".
|
|
47
|
-
2. **Git Bash**: Clone the repo and run `./imagestat` directly.
|
|
48
|
-
|
|
49
|
-
## Usage
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
imagestat [directory]
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
**Download and process:**
|
|
27
|
+
**Download & Process:**
|
|
56
28
|
```bash
|
|
57
|
-
|
|
29
|
+
imgstat -u https://example.com/images
|
|
58
30
|
```
|