Skip to content

Commit

Permalink
docs: update CLI examples for clarity and consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
bushuai committed Jan 18, 2025
1 parent 05c79b9 commit 3ac543f
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions src/content/docs/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1027,15 +1027,12 @@ EXPERIMENTAL: Searches for Grit patterns across a project.

Note: GritQL escapes code snippets using backticks, but most shells interpret backticks as command invocations. To avoid this, it's best to put single quotes around your Grit queries.

## Example

```shell
biome search '`console.log($message)`' # find all `console.log` invocations
```


**Usage**: **`biome`** **`search`** _`PATTERN`_ \[_`PATH`_\]...

```shell
biome search '`console.log($message)`' # find all `console.log` invocations
```

**Global options applied to all commands**
- **` --colors`**=_`<off|force>`_ &mdash;
Set the formatting mode for markup: "off" prints everything as plain text, "force" forces the formatting of markup using ANSI even if the console output is determined to be incompatible
Expand Down Expand Up @@ -1123,19 +1120,15 @@ Note: GritQL escapes code snippets using backticks, but most shells interpret ba

Shows documentation of various aspects of the CLI.

## Examples

```shell
biome explain noDebugger
```


```shell
biome explain daemon-logs
```
**Usage**: **`biome`** **`explain`** _`NAME`_

```shell
# show documentation for lint/suspicious/noDebugger
biome explain noDebugger

**Usage**: **`biome`** **`explain`** _`NAME`_
# obtain the precise path of daemon-logs
biome explain daemon-logs
```

**Available positional items:**
- _`NAME`_ &mdash;
Expand Down

0 comments on commit 3ac543f

Please sign in to comment.