README
¶
servef
Browse any file in a local directory: rendered Markdown, image previews, formatted JSON/YAML/HTML/CSS/JavaScript, and highlighted source for everything else.
Features
- Rendered Markdown, image previews, and highlighted, read-only source
- Format JSON, YAML, HTML, CSS, and JavaScript on demand; files stay unchanged
- Serve several directories; switch repositories and worktrees
- VS Code-style Explorer, Search, Source Control, tabs, and command palette
- Review uncommitted work, commits, a range of commits, or a branch stack layer by layer in one stacked diff tab
- Go to definition and find references through installed language servers
- 28 themes, including Omarchy's built-ins; Mermaid diagrams; line links
Install
Homebrew
brew install flexdinesh/tap/servef
Go
Requires Go 1.26 or later.
Latest stable release:
go install github.com/flexdinesh/servef@latest
Specific stable version:
go install github.com/flexdinesh/servef@v0.1.3
Latest main that passed CI:
go install github.com/flexdinesh/servef@edge
These installs include the embedded frontend; Node.js and pnpm are not required.
Other branches and commits do not include it and fail to build with
go install.
Usage
Serve the current directory:
servef .
See all options:
servef --help
Documentation
Usage, browsing, and code navigation guides live in
site/src/pages.
Contributors: see development and
architecture.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd defines the servef command-line interface.
|
Package cmd defines the servef command-line interface. |
|
internal
|
|
|
browser
Package browser opens URLs and other browser-compatible targets using the operating system's default handler.
|
Package browser opens URLs and other browser-compatible targets using the operating system's default handler. |
|
control
Package control coordinates graceful shutdown between servef processes.
|
Package control coordinates graceful shutdown between servef processes. |
|
document
Package document owns file families and their viewing behavior.
|
Package document owns file families and their viewing behavior. |
|
files
Package files discovers in-scope files and safely resolves indexed paths.
|
Package files discovers in-scope files and safely resolves indexed paths. |
|
git
Package git reads a checkout's uncommitted changes from git's own files: HEAD, refs, objects, and the index.
|
Package git reads a checkout's uncommitted changes from git's own files: HEAD, refs, objects, and the index. |
|
lsp/lsptest
Package lsptest is a fake language server for tests.
|
Package lsptest is a fake language server for tests. |
|
projects
Package projects discovers git repositories and worktrees below served roots and resolves project directories within them.
|
Package projects discovers git repositories and worktrees below served roots and resolves project directories within them. |
|
version
Package version reports servef build metadata.
|
Package version reports servef build metadata. |
|
web
Package web serves an indexed local file workspace and document views.
|
Package web serves an indexed local file workspace and document views. |
|
tools
|
|
|
release-version
command
|
Click to show internal directories.
Click to hide internal directories.