| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 1 | # Command line |
| 2 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 3 | **Note: The `gopls` command-line is still experimental and subject to change at any point.** |
| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 4 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 5 | `gopls` exposes some (but not all) features on the command-line. This can be useful for debugging `gopls` itself. |
| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 6 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 7 | <!--TODO(rstambler): Generate this file.--> |
| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 8 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 9 | Learn about available commands and flags by running `gopls help`. |
| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 10 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 11 | Much of the functionality of `gopls` is available through a command line interface. |
| Rebecca Stambler | 9695483 | 2019-09-15 20:25:54 -0400 | [diff] [blame] | 12 | |
| Rebecca Stambler | d78b04b | 2020-12-28 13:26:14 -0500 | [diff] [blame] | 13 | There are two main reasons for this. The first is that we do not want users to rely on separate command line tools when they wish to do some task outside of an editor. The second is that the CLI assists in debugging. It is easier to reproduce behavior via single command. |
| 14 | |
| 15 | It is not a goal of `gopls` to be a high performance command line tool. Its command line is intended for single file/package user interaction speeds, not bulk processing. |
