Skip to content

Commit f7de1bf

Browse files
committed
fix: clean CLI output paths, high-res demo GIF, README cleanup
- Print relative filenames instead of absolute paths in CLI output - Re-record demo.gif at 1600x800 with clean output - Remove redundant terminal simulation from README (GIF shows it) - Add stacklit-og.png for social sharing
1 parent 6cdd6f9 commit f7de1bf

File tree

7 files changed

+52
-77
lines changed

7 files changed

+52
-77
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,11 @@ AI coding agents burn most of their context window just figuring out where thing
1919
npx stacklit init
2020
```
2121

22-
```
23-
$ stacklit init
24-
[stacklit] found 342 files
25-
[stacklit] parsed 342 files (0 errors)
26-
[stacklit] done in 89ms — wrote stacklit.json, stacklit.mmd, stacklit.html
27-
28-
Opening visual map...
29-
```
30-
3122
![Stacklit demo](demo.gif)
3223

33-
### Without stacklit
24+
**Without stacklit:** Agent reads 8-12 files to build context. ~400,000 tokens. 45 seconds before writing a line.
3425

35-
Agent reads 8-12 files to build context. ~400,000 tokens. 45 seconds of exploration before writing a single line.
36-
37-
### With stacklit
38-
39-
Agent reads `stacklit.json`. ~1,500 tokens. Knows every module, dependency, and convention instantly.
26+
**With stacklit:** Agent reads `stacklit.json`. ~1,500 tokens. Knows every module, dependency, and convention instantly.
4027

4128
## What you get
4229

@@ -75,6 +62,8 @@ A 500-file repo produces ~1,500 tokens of index. That is what an agent wastes re
7562

7663
`stacklit view` opens an interactive HTML with four tabs:
7764

65+
![Stacklit visual map](stacklit-og.png)
66+
7867
- **Graph** -- Force-directed dependency map. Click a node to see its exports, types, and files.
7968
- **Tree** -- Collapsible directory hierarchy with file and line counts.
8069
- **Table** -- Sortable module table. Find where the complexity lives.

demo.gif

-115 KB
Loading

demo.tape

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,23 @@
11
Output demo.gif
22

33
Set Shell "bash"
4-
Set FontSize 14
5-
Set Width 900
6-
Set Height 500
4+
Set FontSize 22
5+
Set Width 1600
6+
Set Height 800
77
Set Theme { "name": "stacklit", "black": "#0d1117", "red": "#f85149", "green": "#56d364", "yellow": "#e3b341", "blue": "#58a6ff", "magenta": "#bc8cff", "cyan": "#39d2c0", "white": "#c9d1d9", "brightBlack": "#484f58", "brightRed": "#f85149", "brightGreen": "#56d364", "brightYellow": "#e3b341", "brightBlue": "#58a6ff", "brightMagenta": "#bc8cff", "brightCyan": "#39d2c0", "brightWhite": "#e6edf3", "background": "#0d1117", "foreground": "#c9d1d9", "selectionBackground": "#264f78", "cursorColor": "#c9d1d9" }
8-
Set Padding 20
8+
Set Padding 30
9+
Set TypingSpeed 40ms
910

10-
Type "# Stacklit: your codebase, in 1,500 tokens"
11-
Enter
12-
Sleep 1s
13-
14-
Type "stacklit init"
15-
Enter
16-
Sleep 3s
17-
18-
Type ""
19-
Sleep 1s
20-
21-
Type "# stacklit.json is now committed to git"
22-
Enter
2311
Sleep 500ms
2412

25-
Type "cat stacklit.json | head -25"
13+
Type "stacklit init"
2614
Enter
2715
Sleep 3s
2816

29-
Type ""
30-
Sleep 1s
17+
Sleep 1.5s
3118

32-
Type "# Start MCP server for AI agents"
19+
Type "head -35 stacklit.json"
3320
Enter
34-
Sleep 500ms
21+
Sleep 4s
3522

36-
Type "# stacklit serve"
37-
Enter
3823
Sleep 2s

internal/engine/engine.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,8 @@ func Run(opts Options) (*Result, error) {
248248
// 13. Print summary.
249249
if !opts.Quiet {
250250
fmt.Printf("[stacklit] done in %s — wrote %s, %s, %s\n",
251-
dur.Round(time.Millisecond), jsonPath, mmdPath, htmlPath)
251+
dur.Round(time.Millisecond),
252+
filepath.Base(jsonPath), filepath.Base(mmdPath), filepath.Base(htmlPath))
252253
}
253254

254255
return &Result{

stacklit-og.png

582 KB
Loading

stacklit.json

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"$schema": "https://stacklit.dev/schema/v1.json",
33
"version": "1",
4-
"generated_at": "2026-04-09T23:56:36Z",
4+
"generated_at": "2026-04-10T00:05:04Z",
55
"stacklit_version": "dev",
6-
"merkle_hash": "fdac4b84e691421e649f3523cb688eb24554439ade7ccea2f27a3d3cb3466ae9",
6+
"merkle_hash": "bd0d1090ba4aff650f9a9d9a308b118e7708043445a2cc9cbc202e800378608e",
77
"project": {
88
"name": "stacklit",
99
"root": ".",
@@ -14,7 +14,7 @@
1414
"languages": {
1515
"go": {
1616
"files": 48,
17-
"lines": 5697
17+
"lines": 5698
1818
},
1919
"java": {
2020
"files": 1,
@@ -47,7 +47,7 @@
4747
"cmd/stacklit/main.go"
4848
],
4949
"total_files": 59,
50-
"total_lines": 5909
50+
"total_lines": 5910
5151
},
5252
"modules": {
5353
"assets": {
@@ -158,7 +158,7 @@
158158
"purpose": "Core orchestration engine",
159159
"language": "go",
160160
"files": 1,
161-
"lines": 554,
161+
"lines": 555,
162162
"file_list": [
163163
"engine.go"
164164
],
@@ -386,14 +386,14 @@
386386
],
387387
"type_defs": {
388388
"Architecture": "Pattern string, Summary string",
389-
"GitInfo": "HotFiles []HotFile, Recent []string, Stable []string",
390389
"Hints": "AddFeature string, TestCmd string, EnvVars []string, DoNotTouch []string",
390+
"HotFile": "Path string, Commits90d int",
391391
"Index": "Schema string, Version string, GeneratedAt string, StacklitVersion string, MerkleHash string, Project Project, Tech Tech, Structure Structure, Modules map[string]ModuleInfo, Dependencies Dependenci...",
392392
"LangStats": "Files int, Lines int",
393+
"ModuleInfo": "Purpose string, Language string, Files int, Lines int, FileList []string, Exports []string, TypeDefs map[string]string, DependsOn []string, DependedBy []string, Activity string",
393394
"MultiIndex": "Schema string, Version string, Type string, GeneratedAt string, TotalFiles int, TotalLines int, TotalModules int, Repos []RepoSummary",
394395
"Project": "Name string, Root string, Type string, Workspaces []string",
395396
"RepoSummary": "Name string, Path string, PrimaryLanguage string, TotalFiles int, TotalLines int, Modules map[string]ModuleInfo, Frameworks []string, Entrypoints []string",
396-
"Structure": "Entrypoints []string, TotalFiles int, TotalLines int, KeyDirectories map[string]string",
397397
"Tech": "PrimaryLanguage string, Languages map[string]LangStats, Frameworks []string"
398398
},
399399
"depended_by": [
@@ -582,15 +582,15 @@
582582
},
583583
{
584584
"path": "stacklit.json",
585-
"commits_90d": 10
585+
"commits_90d": 11
586586
},
587587
{
588588
"path": "stacklit.mmd",
589-
"commits_90d": 10
589+
"commits_90d": 11
590590
},
591591
{
592592
"path": "assets/template.html",
593-
"commits_90d": 9
593+
"commits_90d": 10
594594
},
595595
{
596596
"path": "internal/graph/graph.go",
@@ -600,6 +600,10 @@
600600
"path": "internal/schema/schema.go",
601601
"commits_90d": 7
602602
},
603+
{
604+
"path": "README.md",
605+
"commits_90d": 5
606+
},
603607
{
604608
"path": "go.mod",
605609
"commits_90d": 5
@@ -612,10 +616,6 @@
612616
"path": "go.sum",
613617
"commits_90d": 4
614618
},
615-
{
616-
"path": "README.md",
617-
"commits_90d": 3
618-
},
619619
{
620620
"path": "internal/cli/generate.go",
621621
"commits_90d": 3
@@ -658,28 +658,28 @@
658658
}
659659
],
660660
"recent": [
661-
"npm/README.md",
662-
"npm/bin/stacklit.js",
663-
"npm/package.json",
664661
"README.md",
665-
"SKILL.md",
666662
"assets/template.html",
667-
".github/workflows/ci.yml",
668-
".github/workflows/release.yml",
669-
".goreleaser.yml",
670-
"go.mod"
663+
"demo.gif",
664+
"demo.tape",
665+
"internal/mcp/server.go",
666+
"stacklit.json",
667+
"stacklit.mmd",
668+
"npm/README.md",
669+
"npm/bin/stacklit.js",
670+
"npm/package.json"
671671
],
672672
"stable": [
673673
"LICENSE",
674674
"action/action.yml",
675675
"assets/lang-icons.js",
676+
"demo.gif",
677+
"demo.tape",
676678
"internal/cli/serve.go",
677679
"internal/config/config.go",
678680
"internal/config/config_test.go",
679681
"internal/detect/envvars.go",
680-
"internal/detect/frameworks.go",
681-
"internal/detect/frameworks_test.go",
682-
"internal/git/activity.go"
682+
"internal/detect/frameworks.go"
683683
]
684684
},
685685
"hints": {

stacklit.mmd

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
graph LR
2+
classDef javascript fill:#c9d1d9,color:#0d1117,stroke:#c9d1d9
3+
classDef java fill:#8b949e,color:#0d1117,stroke:#8b949e
24
classDef typescript fill:#c9d1d9,color:#0d1117,stroke:#c9d1d9
35
classDef python fill:#b1bac4,color:#0d1117,stroke:#b1bac4
46
classDef rust fill:#a5b3bf,color:#0d1117,stroke:#a5b3bf
57
classDef go fill:#e6edf3,color:#0d1117,stroke:#e6edf3
6-
classDef javascript fill:#c9d1d9,color:#0d1117,stroke:#c9d1d9
7-
classDef java fill:#8b949e,color:#0d1117,stroke:#8b949e
8+
internal_engine["internal/engine\nCore orchestration engine"]:::go
89
internal_mcp["internal/mcp\nMCP server for AI agents"]:::go
910
internal_monorepo["internal/monorepo\nMonorepo detection"]:::go
10-
internal_renderer["internal/renderer\nOutput renderers"]:::go
11-
npm["npm\nNpm"]:::go
12-
npm_bin["npm/bin\nBin"]:::go
13-
internal_cli["internal/cli\nCommand-line interface"]:::go
14-
internal_detect["internal/detect\nFramework and tool detection"]:::go
15-
cmd_stacklit["cmd/stacklit\nStacklit"]:::go
16-
internal_schema["internal/schema\nData schema definitions"]:::go
17-
assets["assets\nStatic assets"]:::go
18-
internal_engine["internal/engine\nCore orchestration engine"]:::go
1911
internal_parser["internal/parser\nSource code parsers"]:::go
2012
internal_summary["internal/summary\nAI-powered codebase summaries"]:::go
13+
internal_renderer["internal/renderer\nOutput renderers"]:::go
2114
internal_walker["internal/walker\nFile system walker"]:::go
22-
internal_config["internal/config\nConfiguration management"]:::go
15+
internal_cli["internal/cli\nCommand-line interface"]:::go
2316
internal_git["internal/git\nGit integration"]:::go
2417
internal_graph["internal/graph\nDependency graph"]:::go
18+
npm["npm\nNpm"]:::go
19+
assets["assets\nStatic assets"]:::go
20+
internal_config["internal/config\nConfiguration management"]:::go
21+
internal_detect["internal/detect\nFramework and tool detection"]:::go
22+
internal_schema["internal/schema\nData schema definitions"]:::go
23+
npm_bin["npm/bin\nBin"]:::go
24+
cmd_stacklit["cmd/stacklit\nStacklit"]:::go
2525
cmd_stacklit --> internal_cli
2626
internal_cli --> internal_engine
2727
internal_cli --> internal_git

0 commit comments

Comments
 (0)