imgstat 2.0.0 → 2.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/package.json +1 -1
- package/readme.md +17 -16
- package/README.md +0 -27
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -4,27 +4,28 @@
|
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
6
|
**Give AI context about your images.**
|
|
7
|
+
imgstat is a CLI tool that embeds image dimensions directly into filenames, or analyzes remote imagery, to give AI context without needing external parsers.
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
## Features
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
- **AI-Ready Context**: Embeds dimensions directly in filenames.
|
|
12
|
-
- **Idempotent**: Smartly skips images that are already renamed.
|
|
13
|
-
- **Recursive**: Handles deep directory structures.
|
|
11
|
+
imgstat handles renaming smoothly and idempotently—it will never re-append dimensions to a file that already has them. When dealing with remote imagery from URLs or scanning your codebase, it securely generates dimension reports without leaving permanent downloads on your machine. For AI integration, the `analyze` mode seamlessly builds an `.agent/rules/image_dimensions.md` file, giving your local language models instant, zero-config context about the images used in your project.
|
|
14
12
|
|
|
15
|
-
##
|
|
13
|
+
## Usage
|
|
16
14
|
|
|
17
|
-
|
|
18
|
-
```bash
|
|
19
|
-
npm install -g imgstat
|
|
20
|
-
```
|
|
15
|
+
Run `imgstat` with no arguments to get an interactive menu. You will be prompted to select the mode you want to use.
|
|
21
16
|
|
|
22
|
-
**Run:**
|
|
23
17
|
```bash
|
|
24
|
-
imgstat
|
|
18
|
+
imgstat
|
|
25
19
|
```
|
|
26
20
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
21
|
+
## Contribution Rules
|
|
22
|
+
|
|
23
|
+
Keep the tool small. If you are considering adding a feature, ask: **does this help AI understand images faster?** If the answer is not clearly yes, it probably does not belong here.
|
|
24
|
+
|
|
25
|
+
**Every file in `lib/` must have one clear responsibility.** If you find yourself writing image discovery logic inside `rename.sh`, stop and move it to `scan.sh`.
|
|
26
|
+
|
|
27
|
+
**No feature should require memorizing new flags.** If it can be handled by a mode or an interactive prompt, prefer that.
|
|
28
|
+
|
|
29
|
+
**Remote mode must never leave files on disk.** The `trap` cleanup is non-negotiable.
|
|
30
|
+
|
|
31
|
+
**Dry-run must work for any operation that touches files.** This is a safety contract with users.
|
package/README.md
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# imgstat
|
|
2
|
-
|
|
3
|
-
imgstat is a CLI tool that embeds image dimensions directly into filenames, or analyzes remote imagery, to give AI context without needing external parsers.
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
imgstat handles renaming smoothly and idempotently—it will never re-append dimensions to a file that already has them. When dealing with remote imagery from URLs or scanning your codebase, it securely generates dimension reports without leaving permanent downloads on your machine. For AI integration, the `analyze` mode seamlessly builds an `.agent/rules/image_dimensions.md` file, giving your local language models instant, zero-config context about the images used in your project.
|
|
8
|
-
|
|
9
|
-
## Usage
|
|
10
|
-
|
|
11
|
-
Run `imgstat` with no arguments to get an interactive menu. You will be prompted to select the mode you want to use.
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
imgstat
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Contribution Rules
|
|
18
|
-
|
|
19
|
-
Keep the tool small. If you are considering adding a feature, ask: **does this help AI understand images faster?** If the answer is not clearly yes, it probably does not belong here.
|
|
20
|
-
|
|
21
|
-
**Every file in `lib/` must have one clear responsibility.** If you find yourself writing image discovery logic inside `rename.sh`, stop and move it to `scan.sh`.
|
|
22
|
-
|
|
23
|
-
**No feature should require memorizing new flags.** If it can be handled by a mode or an interactive prompt, prefer that.
|
|
24
|
-
|
|
25
|
-
**Remote mode must never leave files on disk.** The `trap` cleanup is non-negotiable.
|
|
26
|
-
|
|
27
|
-
**Dry-run must work for any operation that touches files.** This is a safety contract with users.
|