golang.org/x/tools/gopls@v0.15.3/internal/cmd/usage/usage.hlp (about)

     1  
     2  gopls is a Go language server.
     3  
     4  It is typically used with an editor to provide language features. When no
     5  command is specified, gopls will default to the 'serve' command. The language
     6  features can also be accessed via the gopls command-line interface.
     7  
     8  Usage:
     9    gopls help [<subject>]
    10  
    11  Command:
    12  
    13  Main                
    14    serve             run a server for Go code using the Language Server Protocol
    15    version           print the gopls version information
    16    bug               report a bug in gopls
    17    help              print usage information for subcommands
    18    api-json          print JSON describing gopls API
    19    licenses          print licenses of included software
    20                      
    21  Features            
    22    call_hierarchy    display selected identifier's call hierarchy
    23    check             show diagnostic results for the specified file
    24    codelens          List or execute code lenses for a file
    25    definition        show declaration of selected identifier
    26    execute           Execute a gopls custom LSP command
    27    folding_ranges    display selected file's folding ranges
    28    format            format the code according to the go standard
    29    highlight         display selected identifier's highlights
    30    implementation    display selected identifier's implementation
    31    imports           updates import statements
    32    remote            interact with the gopls daemon
    33    inspect           interact with the gopls daemon (deprecated: use 'remote')
    34    links             list links in a file
    35    prepare_rename    test validity of a rename operation at location
    36    references        display selected identifier's references
    37    rename            rename selected identifier
    38    semtok            show semantic tokens for the specified file
    39    signature         display selected identifier's signature
    40    stats             print workspace statistics
    41    fix               apply suggested fixes
    42    symbols           display selected file's symbols
    43    workspace_symbol  search symbols in workspace
    44  
    45  flags:
    46    -debug=string
    47      	serve debug information on the supplied address
    48    -listen=string
    49      	address on which to listen for remote connections. If prefixed by 'unix;', the subsequent address is assumed to be a unix domain socket. Otherwise, TCP is used.
    50    -listen.timeout=duration
    51      	when used with -listen, shut down the server when there are no connected clients for this duration
    52    -logfile=string
    53      	filename to log to. if value is "auto", then logging to a default output file is enabled
    54    -mode=string
    55      	no effect
    56    -ocagent=string
    57      	the address of the ocagent (e.g. http://localhost:55678), or off (default "off")
    58    -port=int
    59      	port on which to run gopls for debugging purposes
    60    -profile.alloc=string
    61      	write alloc profile to this file
    62    -profile.cpu=string
    63      	write CPU profile to this file
    64    -profile.mem=string
    65      	write memory profile to this file
    66    -profile.trace=string
    67      	write trace log to this file
    68    -remote=string
    69      	forward all commands to a remote lsp specified by this flag. With no special prefix, this is assumed to be a TCP address. If prefixed by 'unix;', the subsequent address is assumed to be a unix domain socket. If 'auto', or prefixed by 'auto;', the remote address is automatically resolved based on the executing environment.
    70    -remote.debug=string
    71      	when used with -remote=auto, the -debug value used to start the daemon
    72    -remote.listen.timeout=duration
    73      	when used with -remote=auto, the -listen.timeout value used to start the daemon (default 1m0s)
    74    -remote.logfile=string
    75      	when used with -remote=auto, the -logfile value used to start the daemon
    76    -rpc.trace
    77      	print the full rpc trace in lsp inspector format
    78    -v,-verbose
    79      	verbose output
    80    -vv,-veryverbose
    81      	very verbose output