gostdsym

package module
v0.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2025 License: MIT Imports: 9 Imported by: 0

README

Fuzzy finding go doc symbols

stdsym simplifies Go documentation exploration by extracting all exported symbols from the standard library, enabling fuzzy searching (fzf) through Go documents.

Demo

Watch a quick demonstration showcasing the usage of this tool:

Demo

Installation

Get started quickly with stdsym:

go install github.com/lotusirous/gostdsym/stdsym@latest

Create a handy gdoc alias for instant symbol lookups:

alias gdoc="stdsym |fzf | xargs go doc "

If you want to view the results on pkg.go.dev and preview them in go doc, use this alias. This example is for macOS, where the open command opens the link in the default browser

alias gd='stdsym -web | fzf --prompt "Symbols> " --preview "go doc \$(echo {} | sed s/#/./g)" --bind "enter:become( echo "https://pkg.go.dev/{}" |xargs open)"'

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetPackageSymbols

func GetPackageSymbols(pattern string, deli string) ([]string, error)

GetPackageSymbols extracts all exported symbols from a package.

func LoadPackages

func LoadPackages(pattern string) ([]string, error)

LoadPackages returns all packages from a given pattern.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL