Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Commit

Permalink
document autocompletion
Browse files Browse the repository at this point in the history
  • Loading branch information
bobheadxi committed Apr 13, 2022
1 parent f60de98 commit a537b93
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions doc/dev/background-information/sg/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,40 @@ On the next command run, if a new version is detected, `sg` will auto update bef

See [configuration](#configuration) to learn more about configuring `sg` behaviour.

### Help

You can get help about commands in a variety of ways:

```sh
sg help # show all available commands

# learn about a specific command or subcommand
sg help <command>
sg h <command>
sg <command> -h
sg <command> --help
```

### Autocompletion

If you have used `sg setup`, you should have autocompletions set up for `sg`. To enable it, type out a partial command and press the <kbd>Tab</kbd> key twice. For example:

```none
sg start<tab><tab>
```

To get autocompletions for the available flags for a command, type out a command and `-` and press the <kbd>Tab</kbd> key twice. For example:

```none
sg start -<tab><tab>
```

Both of the above work if you provide partial values as well to narrow down the suggestions. For example, the following will suggest run sets that start with `web-`:

```none
sg start web-<tab><tab>
```

### `sg start` - Start dev environments

```bash
Expand Down

0 comments on commit a537b93

Please sign in to comment.