Skip to content

Commit

Permalink
added cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
flexatone committed Nov 8, 2024
1 parent 4649739 commit 7203bf8
Showing 1 changed file with 10 additions and 29 deletions.
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,7 @@ repos:
- `--quiet, -q`: Disable logging and terminal animation.
- `--user_site`: Force inclusion of the user site-packages, even if it is not activated. Defaults to only including if the interpreter is configured to use it.

---

### `scan`
### Command `fetter scan`

#### Description

Expand All @@ -220,9 +218,8 @@ Scan the environment to report on installed packages.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `search`
### Command `fetter search`

#### Description

Expand All @@ -238,9 +235,7 @@ Search the environment to report on installed packages based on a pattern.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `count`
### Command `fetter count`

#### Description

Expand All @@ -252,9 +247,7 @@ Count discovered executables, sites, and packages.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `derive`
### Command `fetter derive`

#### Description

Expand All @@ -268,9 +261,7 @@ Derive new requirements from discovered packages.
- `write`: Save derived requirements to a file.
- `--output, -o <FILE>`: Specify the output file.

---

### `validate`
### Command `fetter validate`

#### Description

Expand All @@ -290,9 +281,7 @@ Validate if packages conform to a specified validation target.
- `exit`: Return an exit code (0 for success, customizable for errors).
- `--code, -c <INT>`: Specify the error code (default: `3`).

---

### `audit`
### Command `fetter audit`

#### Description

Expand All @@ -308,9 +297,7 @@ Search for security vulnerabilities in packages via the OSV DB.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `unpack_count`
### Command `fetter unpack_count`

#### Description

Expand All @@ -326,9 +313,7 @@ Count all installed package artifacts.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `unpack_files`
### Command `fetter unpack_files`

#### Description

Expand All @@ -344,9 +329,7 @@ List the file names of all installed package artifacts.
- `--output, -o <FILE>`: Specify the output file.
- `--delimiter, -d <char>`: Set the delimiter for the file (default: `,`).

---

### `purge_pattern`
### Command `fetter purge_pattern`

#### Description

Expand All @@ -356,9 +339,7 @@ Purge packages that match a specific pattern.
- `--pattern, -p <STRING>`: Specify a glob-like pattern to select packages (default: `*`).
- `--case`: Enable case-sensitive pattern matching.

---

### `purge_invalid`
### Command `fetter purge_invalid`

#### Description

Expand Down

0 comments on commit 7203bf8

Please sign in to comment.