Skip to content

Commit 6c7d576

Browse files
authored
docs: detail npx usage
1 parent a200630 commit 6c7d576

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

packages/cli/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This project attempts to analyze npm package contents for issues with their Type
2222
npm i -g @arethetypeswrong/cli
2323
```
2424

25-
<!-- Or, using `npx`: -->
25+
<!-- Or, using `npx`:
2626
<!---->
2727
<!-- ```shell -->
2828
<!-- npx attw -->
@@ -53,6 +53,18 @@ or check a package from npm:
5353
attw --from-npm @arethetypeswrong/cli
5454
```
5555

56+
You can also use `attw` without installing globally by using `npx`. Pack one in-place by specifying `--pack` and a directory:
57+
58+
```
59+
npx --yes @arethetypeswrong/cli --pack .
60+
```
61+
62+
or check a package from npm:
63+
64+
```
65+
npx --yes @arethetypeswrong/cli --from-npm @arethetypeswrong/cli
66+
```
67+
5668
## Configuration
5769

5870
`attw` supports a JSON config file (by default named `.attw.json`) which allows you to pre-set the command line arguments. The options are a one-to-one mapping of the command line flags, changed to camelCase, and are all documented in their relevant `Options` section below.

0 commit comments

Comments
 (0)