Skip to content

Commit d129c2b

Browse files
authored
Merge pull request #199 from johnnyreilly/patch-1
Detail npx usage
2 parents a200630 + 8ad09b7 commit d129c2b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Diff for: packages/cli/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -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)