shellfie-cli 2.0.1 → 2.0.4

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 (3) hide show
  1. package/README.md +26 -8
  2. package/dist/cli.js +0 -0
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -3,10 +3,10 @@
3
3
  Transform your terminal output into beautiful SVG screenshots, directly from the command line.
4
4
 
5
5
  ```sh
6
- npm test | npx shellfie --title "Test Results" -o tests.svg
6
+ npm test | npx shellfie
7
7
  ```
8
8
 
9
- ![npm test](examples/tests.svg)
9
+ ![npm test](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/tests.svg)
10
10
 
11
11
  ✅ **Zero friction** - Pipe any command output and get an SVG instantly.
12
12
  ✅ **Beautiful defaults** - macOS-style terminal window with syntax highlighting.
@@ -16,6 +16,20 @@ npm test | npx shellfie --title "Test Results" -o tests.svg
16
16
 
17
17
  ## Installation
18
18
 
19
+ ### Homebrew (macOS/Linux)
20
+
21
+ ```sh
22
+ brew install tool3/tap/shellfie
23
+ ```
24
+
25
+ ### Shell script (macOS/Linux)
26
+
27
+ ```sh
28
+ curl -fsSL https://raw.githubusercontent.com/tool3/shellfie-cli/master/scripts/install.sh | bash
29
+ ```
30
+
31
+ ### npm
32
+
19
33
  ```sh
20
34
  # Use directly with npx (no install needed)
21
35
  npx shellfie-cli --help
@@ -27,6 +41,10 @@ npm install -g shellfie-cli
27
41
  npm install shellfie-cli --save-dev
28
42
  ```
29
43
 
44
+ ### Download binary
45
+
46
+ Pre-built binaries for macOS, Linux, and Windows are available on the [Releases](https://github.com/tool3/shellfie-cli/releases) page.
47
+
30
48
  ## Quick Start
31
49
 
32
50
  ### Pipe command output
@@ -46,7 +64,7 @@ ls -la --color=always | shellfie --theme nord
46
64
  lolcat --help | shellfie -o lolcat
47
65
  ```
48
66
 
49
- ![npm test](examples/lolcat.svg)
67
+ ![npm test](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/lolcat.svg)
50
68
 
51
69
  ### Read from a file
52
70
 
@@ -138,35 +156,35 @@ shellfie --list-templates
138
156
  ```sh
139
157
  npm test 2>&1 | shellfie --theme dracula --title "Unit Tests" -o tests.svg
140
158
  ```
141
- ![tests dracula](examples/tests-dracula.svg)
159
+ ![tests dracula](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/tests-dracula.svg)
142
160
 
143
161
  ### Git log with minimal template
144
162
 
145
163
  ```sh
146
164
  git log --oneline --graph --color=always | shellfie -t minimal --theme githubDark -o git-log.svg
147
165
  ```
148
- ![git log](examples/git-log.svg)
166
+ ![git log](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/git-log.svg)
149
167
 
150
168
  ### Custom padding and font size
151
169
 
152
170
  ```sh
153
171
  cat script.sh | shellfie --padding "20,30" --font-size 30 -o script.svg
154
172
  ```
155
- ![script](examples/script.svg)
173
+ ![script](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/script.svg)
156
174
 
157
175
  ### Embed font for sharing
158
176
 
159
177
  ```sh
160
178
  ls -l | lolcat -f | shellfie --embed-font -o portable.svg
161
179
  ```
162
- ![portable](examples/portable.svg)
180
+ ![portable](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/portable.svg)
163
181
 
164
182
  ### Add watermark
165
183
 
166
184
  ```sh
167
185
  ifconfig | grep inet | shellfie --watermark "@$USER" --theme monokai
168
186
  ```
169
- ![watermark](examples/watermark.svg)
187
+ ![watermark](https://raw.githubusercontent.com/tool3/shellfie-cli/refs/heads/master/examples/watermark.svg)
170
188
 
171
189
  ### Colored watermark
172
190
 
package/dist/cli.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "shellfie-cli",
3
- "version": "2.0.1",
4
- "description": "Transform terminal output into beautiful SVG images from the command line",
3
+ "version": "2.0.4",
4
+ "description": "Terminal output to beautiful SVGs",
5
5
  "bin": {
6
6
  "shellfie": "dist/cli.js"
7
7
  },
@@ -31,7 +31,7 @@
31
31
  "author": "tool3",
32
32
  "license": "MIT",
33
33
  "dependencies": {
34
- "shellfie": "^2.0.2",
34
+ "shellfie": "^2.0.5",
35
35
  "yargs": "^17.7.2"
36
36
  },
37
37
  "devDependencies": {