profiler-md 0.1.0 → 0.1.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/dist/cli.mjs +6 -1
- package/dist/index.d.mts +5 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/readme.md +22 -3
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -28,9 +28,15 @@
|
|
|
28
28
|
|
|
29
29
|
## Features
|
|
30
30
|
|
|
31
|
-
- **
|
|
31
|
+
- **Multi-format:** supports [pprof](https://github.com/google/pprof),
|
|
32
|
+
[Speedscope](https://github.com/jlfwong/speedscope),
|
|
33
|
+
[V8 CPU profiles](https://nodejs.org/api/cli.html#cpu-prof),
|
|
34
|
+
[V8 heap profiles](https://nodejs.org/api/cli.html#--heap-prof), and
|
|
35
|
+
[V8 heap snapshots](https://nodejs.org/api/cli.html#heapsnapshot-near-heap-limitmax-count)
|
|
36
|
+
- **Multi-language:** JS/TS via V8 formats (Node.js, Bun, Deno); Go, Python,
|
|
37
|
+
Rust, Java, and more via pprof and Speedscope
|
|
32
38
|
- **Configurable:** control the number of top entries shown, working directory
|
|
33
|
-
for relative paths,
|
|
39
|
+
for relative paths, third-party detection, and entry filtering
|
|
34
40
|
- **CLI and API:** usable on the command-line or programmatically
|
|
35
41
|
|
|
36
42
|
## Install
|
|
@@ -54,7 +60,7 @@ $ profiler-md --help
|
|
|
54
60
|
|
|
55
61
|
Options:
|
|
56
62
|
-t, --type <type> Profile type, auto-detected from content if omitted
|
|
57
|
-
[speedscope|v8-cpu-profile|v8-heap-profile|v8-heap-snapshot
|
|
63
|
+
[pprof|speedscope|v8-cpu-profile|v8-heap-profile|v8-heap-snapshot]
|
|
58
64
|
-o, --output <file> Output file (default: - for stdout)
|
|
59
65
|
--top-n <n> Number of top entries to show (default: 20)
|
|
60
66
|
--cwd <path> Working directory for relative file paths in output
|
|
@@ -114,6 +120,19 @@ console.log(v8HeapProfileToMd(v8HeapProfileData, options))
|
|
|
114
120
|
console.log(v8HeapSnapshotToMd(v8HeapSnapshotData, options))
|
|
115
121
|
```
|
|
116
122
|
|
|
123
|
+
## Skills
|
|
124
|
+
|
|
125
|
+
Use this `profiler-md` skill to have an agent profile and optimize your code:
|
|
126
|
+
|
|
127
|
+
```sh
|
|
128
|
+
$ npx skills add TomerAberbach/profiler-md --skill profile-optimize
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
See [skills.sh](https://skills.sh/docs) for more info.
|
|
132
|
+
|
|
133
|
+
Fun fact: the skill has been used to profile and optimize `profiler-md` using
|
|
134
|
+
itself!
|
|
135
|
+
|
|
117
136
|
## Contributing
|
|
118
137
|
|
|
119
138
|
Stars are always welcome!
|