From 930718ec4da43630dd7645b8ab7fb11ce4732a03 Mon Sep 17 00:00:00 2001 From: Nicolas Ritouet Date: Wed, 21 Jan 2026 08:19:46 +0100 Subject: [PATCH] docs: fix README inconsistencies and outdated info MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix install URL: https://get.keyway.sh → https://keyway.sh/install.sh - Fix flag: --env → -e - Remove non-existent --ci flag reference - Fix example: keyway pull --env production → keyway pull -e production Co-Authored-By: Claude Opus 4.5 --- README.md | 8 ++++---- npm/README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3b23eaf..3bc4003 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ brew install keywaysh/tap/keyway ### Install Script ```bash -curl -fsSL https://get.keyway.sh | sh +curl -fsSL https://keyway.sh/install.sh | sh ``` ### npx (no install) @@ -85,7 +85,7 @@ Never write secrets to disk. Inject them directly into your process: ```bash keyway run -- npm start -keyway run --env production -- ./my-app +keyway run -e production -- ./my-app ``` Secrets exist only in memory. When the process exits, they're gone. @@ -135,7 +135,7 @@ We can't read your secrets. Even if our database leaks, attackers get encrypted | Variable | Description | |----------|-------------| -| `KEYWAY_TOKEN` | Auth token for CI/CD (use `keyway login --ci`) | +| `KEYWAY_TOKEN` | Auth token for CI/CD (create in Dashboard > API Keys) | | `KEYWAY_API_URL` | Custom API endpoint | | `KEYWAY_DISABLE_TELEMETRY=1` | Disable anonymous analytics | @@ -163,7 +163,7 @@ Use an API key for automation: # GitHub Actions example env: KEYWAY_TOKEN: ${{ secrets.KEYWAY_TOKEN }} -run: keyway pull --env production +run: keyway pull -e production ``` Or use the [GitHub Action](https://github.com/keywaysh/keyway-action): diff --git a/npm/README.md b/npm/README.md index 3b23eaf..3bc4003 100644 --- a/npm/README.md +++ b/npm/README.md @@ -40,7 +40,7 @@ brew install keywaysh/tap/keyway ### Install Script ```bash -curl -fsSL https://get.keyway.sh | sh +curl -fsSL https://keyway.sh/install.sh | sh ``` ### npx (no install) @@ -85,7 +85,7 @@ Never write secrets to disk. Inject them directly into your process: ```bash keyway run -- npm start -keyway run --env production -- ./my-app +keyway run -e production -- ./my-app ``` Secrets exist only in memory. When the process exits, they're gone. @@ -135,7 +135,7 @@ We can't read your secrets. Even if our database leaks, attackers get encrypted | Variable | Description | |----------|-------------| -| `KEYWAY_TOKEN` | Auth token for CI/CD (use `keyway login --ci`) | +| `KEYWAY_TOKEN` | Auth token for CI/CD (create in Dashboard > API Keys) | | `KEYWAY_API_URL` | Custom API endpoint | | `KEYWAY_DISABLE_TELEMETRY=1` | Disable anonymous analytics | @@ -163,7 +163,7 @@ Use an API key for automation: # GitHub Actions example env: KEYWAY_TOKEN: ${{ secrets.KEYWAY_TOKEN }} -run: keyway pull --env production +run: keyway pull -e production ``` Or use the [GitHub Action](https://github.com/keywaysh/keyway-action):