Skip to content

Commit 7d355f4

Browse files
authored
docs: use npx for cli instructions (#184)
Signed-off-by: Joshua Li <joshuali925@gmail.com>
1 parent 3fef872 commit 7d355f4

File tree

3 files changed

+3
-12
lines changed

3 files changed

+3
-12
lines changed

aws/cli-installer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Deploy the [Observability Stack](https://github.com/opensearch-project/observabi
55
## Quick Start
66

77
```bash
8-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/opensearch-project/observability-stack/main/install.sh)" -- --deployment-target=aws
8+
npx @opensearch-project/observability-stack
99
```
1010

1111
Takes ~15 minutes. When complete, the CLI prints a dashboard URL — open it and you're in.

docs/starlight-docs/src/content/docs/deploy/aws.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Deploy the Observability Stack to AWS using managed services. This creates the s
1616
Interactive single-command deploy. Creates all resources, configures dashboards, and optionally launches an EC2 instance running the [OpenTelemetry Demo](https://opentelemetry.io/docs/demo/) for sample telemetry.
1717

1818
```bash
19-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/opensearch-project/observability-stack/main/install.sh)" -- --deployment-target=aws
19+
npx @opensearch-project/observability-stack
2020
```
2121

2222
Takes ~15 minutes. See [aws/cli-installer/README.md](https://github.com/opensearch-project/observability-stack/tree/main/aws/cli-installer) for full options.

install.sh

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -956,16 +956,7 @@ run_aws_installer() {
956956
exit 1
957957
fi
958958

959-
# Clone repo and install deps
960-
echo -e " Cloning repository..."
961-
TMPDIR=$(mktemp -d)
962-
git clone --depth 1 "$REPO_URL" "$TMPDIR" --quiet
963-
cd "$TMPDIR/aws/cli-installer"
964-
npm install --silent 2>/dev/null
965-
966-
# Forward args to CLI
967-
echo ""
968-
node bin/cli-installer.mjs "${AWS_CLI_ARGS[@]}"
959+
npx -y @opensearch-project/observability-stack "${AWS_CLI_ARGS[@]}"
969960
}
970961

971962
main() {

0 commit comments

Comments
 (0)