Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brynary committed Nov 18, 2024
1 parent de32d93 commit 8796abd
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,48 @@ Qlty CLI is implemented in Rust, supported by [Qlty Software](https://qlty.sh),

Qlty CLI is available for MacOS, Linux, and Windows.

### Install on MacOS or Linux

```bash
# Install on MacOS or Linux:
curl https://qlty.sh | bash
```

### Install on Windows

# Install on Windows:
```bash
powershell -c "iwr https://qlty.sh | iex"
```

## Usage

Setup Qlty within a Git repository:

```bash
# Setup Qlty within a Git repository:
cd my_repo/
qlty init
```

View a sample of lint issues:

# View a sample of lint issues:
```bash
qlty check --sample=5
```

# Auto-format the codebase
Auto-format the codebase:

```bash
qlty fmt --all
```

Scan for code smells like duplication:

# Scan for code smells like duplication:
```bash
qlty smells --all
```

# Review a summary of code quality metrics
Review a summary of code quality metrics:

```bash
qlty metrics --all --max-depth=2 --sort complexity --limit 10
```

Expand Down

0 comments on commit 8796abd

Please sign in to comment.