zammy 1.2.0 → 1.2.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 +37 -6
- package/SECURITY.md +57 -0
- package/dist/index.js +708 -119
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Zammy CLI
|
|
4
4
|
|
|
5
|
-
**Your
|
|
5
|
+
**Your friendly terminal companion with utilities, dev tools, and a purple slime mascot**
|
|
6
6
|
|
|
7
7
|
[](https://github.com/aayushadhikari7/zammy-cli/actions/workflows/test.yml)
|
|
8
8
|
[](https://www.npmjs.com/package/zammy)
|
|
@@ -19,7 +19,9 @@
|
|
|
19
19
|
╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
A
|
|
22
|
+
A feature-packed CLI that combines utilities, dev tools, and a bit of fun into an interactive terminal experience.
|
|
23
|
+
|
|
24
|
+

|
|
23
25
|
|
|
24
26
|
[Features](#features) • [Installation](#installation) • [Commands](#commands) • [Contributing](#contributing)
|
|
25
27
|
|
|
@@ -47,13 +49,15 @@ A delightful, feature-rich terminal companion that combines utility tools, fun c
|
|
|
47
49
|
|
|
48
50
|
## Features
|
|
49
51
|
|
|
52
|
+
- **Meet Zammy** — Your friendly CLI mascot! An animated purple slime that blinks and reacts to your mood
|
|
50
53
|
- **Interactive Command Menu** — Type `/` to browse all commands with arrow key navigation
|
|
54
|
+
- **Mood Reactions** — Type "thanks", "wow", or even ":(" and Zammy reacts with different emotions
|
|
51
55
|
- **Tab Autocomplete** — Quick command completion with Tab key
|
|
52
56
|
- **Enhanced Shell Commands** — Supercharged `!` commands with colors, icons, and extra features
|
|
53
57
|
- **Beautiful ASCII Art** — Convert images to ASCII with multiple styles and edge detection
|
|
54
58
|
- **Rich UI** — Colorful output, box drawings, gradients, and Unicode symbols
|
|
55
59
|
- **Cross-Platform** — Works on Windows, macOS, and Linux
|
|
56
|
-
- **
|
|
60
|
+
- **Simple Mode** — Use `--simple` for terminals that don't support animations
|
|
57
61
|
|
|
58
62
|
## Installation
|
|
59
63
|
|
|
@@ -89,8 +93,14 @@ zammy
|
|
|
89
93
|
# Check version
|
|
90
94
|
zammy --version
|
|
91
95
|
|
|
92
|
-
#
|
|
96
|
+
# Simple mode (no animations)
|
|
93
97
|
zammy --simple
|
|
98
|
+
|
|
99
|
+
# Disable interactive menu
|
|
100
|
+
zammy --no-menu
|
|
101
|
+
|
|
102
|
+
# Minimal mode (no animations, no menu)
|
|
103
|
+
zammy --simple --no-menu
|
|
94
104
|
```
|
|
95
105
|
|
|
96
106
|
Once inside Zammy:
|
|
@@ -124,6 +134,7 @@ zammy❯ /asciiart @img.png # Convert image to ASCII
|
|
|
124
134
|
|
|
125
135
|
| Command | Description |
|
|
126
136
|
|---------|-------------|
|
|
137
|
+
| `/zammy [mood]` | Say hi to Zammy! Try: `happy`, `excited`, `love`, `sleepy`, `angry`, `moods` |
|
|
127
138
|
| `/joke` | Get a random programming joke |
|
|
128
139
|
| `/quote` | Get an inspirational quote |
|
|
129
140
|
| `/fortune` | Get your fortune told (with lucky numbers!) |
|
|
@@ -233,6 +244,25 @@ Type `/` or `!` to open an interactive command menu:
|
|
|
233
244
|
- **Escape** — Close menu
|
|
234
245
|
- Type to filter commands
|
|
235
246
|
|
|
247
|
+
### Zammy's Mood Reactions
|
|
248
|
+
|
|
249
|
+
Zammy responds to your emotions! Just type naturally (without `/` or `!`):
|
|
250
|
+
|
|
251
|
+
| Keywords | Zammy's Mood |
|
|
252
|
+
|----------|--------------|
|
|
253
|
+
| `thanks`, `love you`, `ty` | Shows love with hearts |
|
|
254
|
+
| `wow`, `awesome`, `cool` | Gets excited with stars |
|
|
255
|
+
| `tired`, `sleepy`, `zzz` | Yawns sleepily |
|
|
256
|
+
| `:(`, `ugh`, `damn` | Reacts with frustration |
|
|
257
|
+
| `sad`, `sorry`, `fail` | Shows sympathy |
|
|
258
|
+
| `hmm`, `maybe`, `idk` | Thinks along with you |
|
|
259
|
+
|
|
260
|
+
For `love` and `excited` moods, there's a 50% chance Zammy shows the full mascot!
|
|
261
|
+
|
|
262
|
+
### Idle Animation
|
|
263
|
+
|
|
264
|
+
When you're idle for a few seconds, a mini Zammy appears and blinks at you. Start typing and it disappears!
|
|
265
|
+
|
|
236
266
|
### Tab Completion
|
|
237
267
|
|
|
238
268
|
```bash
|
|
@@ -286,9 +316,10 @@ zammy-cli/
|
|
|
286
316
|
│ │ ├── fun/ # Dice, flip, fortune logic
|
|
287
317
|
│ │ └── creative/ # Lorem, color logic
|
|
288
318
|
│ └── ui/ # UI components
|
|
289
|
-
│ ├── banner.ts # Welcome screen
|
|
319
|
+
│ ├── banner.ts # Welcome screen with animated mascot
|
|
290
320
|
│ ├── colors.ts # Theme, symbols
|
|
291
|
-
│
|
|
321
|
+
│ ├── prompt.ts # CLI prompt
|
|
322
|
+
│ └── slime-animated.ts # Zammy mascot moods & reactions
|
|
292
323
|
├── dist/ # Compiled output
|
|
293
324
|
└── package.json
|
|
294
325
|
```
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
| ------- | ------------------ |
|
|
7
|
+
| 1.2.x | :white_check_mark: |
|
|
8
|
+
|
|
9
|
+
## Reporting a Vulnerability
|
|
10
|
+
|
|
11
|
+
I take security seriously and appreciate your help in keeping Zammy CLI safe for everyone.
|
|
12
|
+
|
|
13
|
+
This is a solo project, and I'm always glad to hear from the community. If you discover a security vulnerability, please don't hesitate to report it—no matter how small it may seem. I won't judge or dismiss your findings, and I genuinely appreciate the time you take to help improve this project.
|
|
14
|
+
|
|
15
|
+
### How to Report
|
|
16
|
+
|
|
17
|
+
1. **Please do not open a public GitHub issue** for security vulnerabilities, as this could put other users at risk
|
|
18
|
+
2. Instead, use [GitHub's private security advisory](https://github.com/aayushadhikari7/zammy-cli/security/advisories/new) to report the issue securely
|
|
19
|
+
3. Include whatever details you can:
|
|
20
|
+
- Description of the vulnerability
|
|
21
|
+
- Steps to reproduce (if known)
|
|
22
|
+
- Potential impact
|
|
23
|
+
- Suggested fix (optional, but welcome!)
|
|
24
|
+
|
|
25
|
+
Don't worry if you're unsure about the severity or if your report is "good enough"—I'd rather hear about a potential issue than miss a real one.
|
|
26
|
+
|
|
27
|
+
### What to Expect
|
|
28
|
+
|
|
29
|
+
- **Acknowledgment** within 48 hours
|
|
30
|
+
- **Regular updates** on the fix progress
|
|
31
|
+
- **Credit** in the release notes (unless you prefer to remain anonymous)
|
|
32
|
+
- **No legal action** for responsible disclosure—I'm grateful for your help
|
|
33
|
+
|
|
34
|
+
### Scope
|
|
35
|
+
|
|
36
|
+
This security policy applies to:
|
|
37
|
+
- The `zammy` npm package
|
|
38
|
+
- This GitHub repository
|
|
39
|
+
|
|
40
|
+
## Security Overview
|
|
41
|
+
|
|
42
|
+
For transparency, here's what Zammy CLI does and doesn't do:
|
|
43
|
+
|
|
44
|
+
**Does NOT:**
|
|
45
|
+
- Collect telemetry or analytics
|
|
46
|
+
- Store or transmit personal data
|
|
47
|
+
- Make network requests without explicit user commands
|
|
48
|
+
- Execute code without user input
|
|
49
|
+
|
|
50
|
+
**Does:**
|
|
51
|
+
- Require explicit user input for all shell commands
|
|
52
|
+
- Use timeouts on all external operations
|
|
53
|
+
- Respect your local environment and working directory
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
Thank you for helping keep Zammy CLI secure. Community feedback—whether it's bug reports, feature ideas, or security concerns—is always welcome and appreciated.
|