Skip to content

Commit bee90fb

Browse files
committed
docs: update cli.md
1 parent 4b24b4a commit bee90fb

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

docs/development/cli.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# CLI Development
2+
> Maintaining code around the CLI tool
23
3-
The code is in [src/cli/](/src/cli).
4+
The code is in [src/cli/](/src/cli). The CLI commands are built using steps set in [package.json](/package.json) - see the `cli` command and `bin` section.
5+
6+
7+
## Run directly
8+
9+
```sh
10+
$ npx ts-node src/cli/diffIndexGenerate.ts
11+
```
412

5-
The CLI commands are built using steps set in [package.json](/package.json) - see the `cli` command and `bin` section.
613

714
## Package as a binary
815

16+
To send to someone so they can use it without having Node installed or running a build step on their machine.
17+
918
```sh
1019
$ npx --yes pkg out/cli/diffIndexGenerateCommit.js -t node18-macos
1120
```

0 commit comments

Comments
 (0)