Skip to content

Commit

Permalink
doc: update new command name ast-grep
Browse files Browse the repository at this point in the history
  • Loading branch information
HerringtonDarkholme committed May 13, 2023
1 parent 2dd0454 commit e361811
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions website/guide/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,16 @@ brew tap ast-grep/tap
brew install ast-grep/tap/ast-grep
```

The binary command, `sg`, should be available now. Let's try it with `--help`.
The binary command, `sg`, or `ast-grep`, should be available now. Let's try it with `--help`.

```shell
sg --help
# if you are on Linux
ast-grep --help
```

:::danger Use `sg` on Linux
Linux has a default command `sg` for `setgroups`. You must specify `sg` command's path.
If you installed `ast-grep` via cargo, you can use `~/.cargo/bin/sg` instead of `sg`.
Linux has a default command `sg` for `setgroups`. You can use the full command name `ast-grep` instead of `sg`.
:::


Expand Down

0 comments on commit e361811

Please sign in to comment.