Skip to content

Commit 11b6633

Browse files
committed
update cli.md, cli.md and TODO.md
1 parent 96d4fb2 commit 11b6633

3 files changed

Lines changed: 17 additions & 5 deletions

File tree

docs/cli.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,14 @@ _This should work on Windows too but has not been tested yet._
1212

1313
Requires Git and Node.
1414

15-
<!-- TODO replace with instructions for downloading from a release using manual steps and install with curl or npm
15+
<!-- TODO replace with instructions for **downloading** from a release using manual steps and install with curl or npm
1616
Note you do not need Git or Node, you can download the pre-packaged CLI tool as a binary.
17+
18+
For now:
19+
20+
npm run build:install
21+
cp build-cli/acm-macos ~/.local/bin/acm
22+
1723
-->
1824

1925
```sh

docs/development/cli.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# CLI Development
22
> Maintaining code around the CLI tool
33
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-
4+
The code is in [src/cli/](/src/cli). The CLI commands are built using steps set in [package.json](/package.json).
65

6+
- See `cli:install` and `bin` section, which are both related and work with `npm link`.
7+
- See `make cli-build` which is for building binaries with `pkg` for distribution.
78

89
## Run directly
910

11+
For testing:
12+
1013
```sh
1114
$ npx ts-node src/cli/diffIndexGenerate.ts
1215
```
@@ -45,4 +48,6 @@ Check:
4548
ls -l $(realpath /opt/homebrew/bin/acm)
4649
```
4750

48-
See [package.json](/package.json). Supposedly you should be able to leave out the project name when running `npm link` via an `npm run ...` command but I found this causes issues, so decided to always use the full name in the configuration. And to _always_ unlink then link in one go because of permissions issues.
51+
See [package.json](/package.json).
52+
53+
Supposedly you should be able to leave out the project name when running `npm link` via an `npm run ...` command but I found this causes issues, so decided to always use the full name in the configuration. But removed it later . And to _always_ unlink then link in one go because of permissions issues.

shell/TODO.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ of template, so it that can be passed on.
1313
there's a problem - commit does not take cached flag - but it will use implied staged or not. so do not pass through.
1414
BUT could look at advanced mode of pass through names of files to commit IF they are handled by status and commit, but using manual git add is good enough probably. esp for untracked files which need add anyway.
1515
- [ ] See if it is possible to make the shell script here shorter and use the logic in acm instead and a minimal .sh hook file.
16-
- [ ] Fix issue where if using the `cli:install` command then doing a build that removes everything means the commands don't work. Perhaps a **different output directory**.
16+
- [ ] Fix issue where if using the `cli:install` command then doing a build that removes everything means the commands don't work. Perhaps a **different output directory**. Note `cli-build` can work though it is used pkg and renames (sometimes locally and also on CLI), so maybe different.
1717
- [ ] Rename - this doesn't have to be shell anymore. Like `hooks`. Just fix any references to shell directory.
18+
- [ ] Build all scripts.

0 commit comments

Comments
 (0)