Skip to main content

Frequently asked questions

How is this different from VS Code's "Outline" view?​

The native Outline view shows the symbols of the active file from the language server, that is all. GhostMap adds:

  • Automatic fallback when the language server is not responding or not available, using Tree-sitter and regex. In the 19 supported languages (see Requirements) this usually means you still have a tree even when Outline is empty. In languages outside that list (planned expansion workstream, see Disclaimer) there is no tree: GhostMap does not invent structure.
  • @ghost annotations woven into the tree: named TODOs, marked regions, descriptions with status, all navigable.
  • Per-file persistent snapshot across sessions: opening a previously seen file paints the tree in < 50 ms; you do not have to wait for the LSP. Today that cache is per-document, not a full workspace index: that is V2 (see Roadmap).
  • Progressive scanner for files of 60k lines without freezing the editor.
  • Diagnostics on your anchors plus quick fixes.

Outline is still useful for languages where the LSP is excellent and you do not need anchors. GhostMap is the option when you work on large files, switch languages constantly, or want structured marks in your code.

Does it require anything besides the extension?​

No. The 19 Tree-sitter grammars are pre-compiled inside the extension; they are not downloaded at runtime. If you have an active language server for your language, GhostMap will use it automatically; otherwise it uses the fallback. See Requirements.

Does it work offline?​

Yes. GhostMap makes no network calls. All symbol extraction, anchor parsing, persistence, and analysis happens locally.

Does it send data to any server?​

No. The extension does not send project data (code, file content, paths, telemetry, or metadata) to maintainers or to GhostMap servers. For a copy of the active Privacy Policy, write to getghostmap@proton.me.

Does it work on VS Code Web / vscode.dev?​

In a limited way. GhostMap declares itself as extensionKind: ["workspace"], which means it requires a full extension host. In virtual environments like vscode.dev, the Ghost Tree works in memory but persistence to .ghostmap/ghostmap.json is not available.

What about the .ghostmap/ folder?​

It is the local cache GhostMap keeps per workspace. It contains the snapshot trees for files you have opened. See Where does GhostMap store data? for more detail.

Should I commit it? No. Add it to .gitignore:

.ghostmap/

Is it safe to delete? Yes. The next open of each file pays the extraction cost once and the cache is repopulated.

Why are files > 60k lines flagged as [skipped]?​

To keep the editor responsive. The regex scanner evaluates one pattern per line per language, and above roughly 60k lines the accumulated cost degrades responsiveness. If you need to analyze a larger file:

  • Raise ghostmap.loading.maxAutoLines.
  • Or enable ghostmap.loading.allowManualLargeFileRefresh and fire the refresh manually with GhostMap: Refresh.

See Settings.

Why are there so many language "tiers"?​

Some languages have grammars that a regex- and Tree-sitter-based scanner covers fully (Tier 1). Others have features that would need a real specific parser (Tier 2, Tier 3). The Disclaimer details known gaps per language.

How big is the extension?​

The download is about 35 MB, dominated by the 19 Tree-sitter grammars in WASM. Active memory cost is low: only the grammars for languages you have touched in the session are loaded.

Does GhostMap use AI?​

Not in V1. All extraction is deterministic (LSP / Tree-sitter / regex). V2 contemplates AI-assisted features (automatic explanations, Range Anchor suggestions) but they will be optional and announced explicitly when they arrive.

How do I create an Anchor?​

The quickest way is to type gh and press Tab on the line above a symbol. The snippet generates a Contextual Anchor that attaches to the closest symbol. See First 5 minutes and Syntax.

Can I put @ghost inside a block comment /* */?​

Not in V1. Only line comments are recognized (// or #). See Syntax: line comments only.

Are there default keyboard shortcuts?​

Yes, one: Ctrl+Alt+G (Cmd+Alt+G on macOS) runs GhostMap: Refresh while the editor has focus. See Keyboard shortcuts.

What license does GhostMap V1 use?​

GhostMap V1 ships as source-available under the GhostMap Free Non-Commercial License: the code is readable and personal, educational, and evaluation/testing use is free. Commercial, business, production, or revenue-generating use requires written authorization (or a future commercial license flow). Donations do not grant commercial rights. The Enterprise vision is roadmap, not shipped today. See the Terms of Use (shipped as LICENSE; questions to getghostmap@proton.me) and the Roadmap.

Why is GhostMap not on VS Code Marketplace or Open VSX yet?​

Today GhostMap installs via a local VSIX built from the repo with npx @vscode/vsce package. GitHub Releases is a planned post-tag channel; there is no public release yet.

  • VS Code Marketplace: pending. The package does not have a publisher configured in package.json yet; the publisher has to be registered in Marketplace and the first vsce publish has to run. In the meantime, installing by VSIX is functionally equivalent to the Marketplace, just without automatic in-editor updates.
  • Open VSX: planned. It will be the bridge for users of VSCodium, Cursor, Gitpod, and other editors that consume Open VSX instead of Microsoft's Marketplace. Planned to publish before or in parallel with Marketplace approval. The publish script (publish:open-vsx, calling ovsx publish) is already prepared in package.json of the genesis repo; namespace registration in open-vsx.org, the token, and the first publish are pending.

While those channels are pending / planned, the official path is in Install and Install from VSIX.

How do I uninstall it?​

See How to uninstall.

Next step​

If you have a specific problem, write to getghostmap@proton.me with reproduction steps.

Last updated on