Skip to content

Commit d5ebf65

Browse files
committed
docs: add npm 11 approve-scripts step to install instructions
npm 11+ gates lifecycle scripts (postinstall, postuninstall) behind explicit user approval. Until 'npm approve-scripts @gilbertwong1996/ado' is run, the postinstall hook that auto-installs shell completion is silently skipped and users see a warning instead. Update both README.md and github-page/index.html to include the one-time approval command in the npm install path.
1 parent 8f56e18 commit d5ebf65

2 files changed

Lines changed: 29 additions & 6 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,38 @@ so they load natively on startup.
4646

4747
## Installation
4848

49+
### npm (recommended)
50+
4951
```bash
50-
git clone https://github.com/gilbertwong96/ado_cli.git
51-
cd ado_cli
52-
mix deps.get
53-
mix escript.build
52+
npm install -g @gilbertwong1996/ado
53+
npm approve-scripts @gilbertwong1996/ado # npm 11+: allow the postinstall to auto-install shell completion
5454
```
5555

56-
Move the escript into your PATH:
56+
> **npm 11+ note**: newer npm versions gate lifecycle scripts behind explicit
57+
> approval. Run the second command above once — the postinstall will then
58+
> auto-install shell completion on every `npm install -g` afterward.
59+
60+
### Pre-built binaries
61+
62+
Download the binary for your platform from the
63+
[latest release](https://github.com/gilbertwong96/ado_cli/releases/latest) and
64+
put it on your `$PATH`:
5765

5866
```bash
67+
# Example for Apple Silicon Mac (pick the right binary for your platform)
68+
curl -L -o ado https://github.com/gilbertwong96/ado_cli/releases/latest/download/ado-0.2.1-macos-aarch64
69+
chmod +x ado && sudo mv ado /usr/local/bin/
70+
```
71+
72+
### From source
73+
74+
Requires Elixir 1.20+ and Mix:
75+
76+
```bash
77+
git clone https://github.com/gilbertwong96/ado_cli.git
78+
cd ado_cli
79+
mix deps.get
80+
mix escript.build
5981
cp ado /usr/local/bin/
6082
```
6183

github-page/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ <h1>The Azure DevOps CLI<br>for humans <em>and</em> LLM agents</h1>
3838
<div class="install-row install-row-hero">
3939
<div class="install-cmd">
4040
<span class="label">npm <span class="recommended-pill">recommended</span></span>
41-
<pre><code>npm install -g @gilbertwong1996/ado</code></pre>
41+
<pre><code>npm install -g @gilbertwong1996/ado
42+
npm approve-scripts @gilbertwong1996/ado # npm 11+ one-time setup</code></pre>
4243
</div>
4344
</div>
4445
<p class="hero-hint">Works on macOS, Linux, and Windows. <a href="#install">Other install methods →</a></p>

0 commit comments

Comments
 (0)