From c66f724d6da0ebebd978d31aaae9d64c4df9509c Mon Sep 17 00:00:00 2001 From: caballeto Date: Tue, 5 May 2026 19:48:53 +0200 Subject: [PATCH] docs(README): fix token format, create-flag, and MCP install drift MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Five small docs/reality drifts surfaced by a fresh-user devex agent run that follows only public docs: 1. Token examples used `sk_live_...` / `sk_test_...` — these are Stripe-style prefixes that don't match what the API actually issues. Real DevHelm tokens are `dh_live_...` / `dh_test_...` (verified against a working prod token). Updated three call sites: - `devhelm auth login --token sk_live_...` - `export DEVHELM_API_TOKEN=sk_live_...` - `devhelm auth context create staging --token sk_test_...` 2. `monitors create` example used `--interval 30`, but the actual flag exposed by `src/lib/resources.ts` is `--frequency`. The example as written errors with `Nonexistent flag: --interval`. Bumped the example value to 60s while I was there (the API minimum for HTTP monitors). 3. The "AI Agents" section advertised `npm install -g @devhelm/mcp-server`, but the MCP server has only ever shipped as the Python package `devhelm-mcp-server` on PyPI (not on npm). Updated to `pip install devhelm-mcp-server` (with a `uvx devhelm-mcp-server` no-install alternative). Same identity-drift fix as devhelmhq/mono#358. No code changes — README only. Refs: pre-launch DevEx agent reports. Co-authored-by: Cursor --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8ad2610..946e20a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The official command-line interface for [DevHelm](https://devhelm.io) — manage ```bash # Authenticate -$ devhelm auth login --token sk_live_... +$ devhelm auth login --token dh_live_... Authenticated as you@company.com Context 'default' saved to ~/.devhelm/contexts.json @@ -27,7 +27,7 @@ $ devhelm monitors list └────┴─────────────────────┴──────┴────────┴──────────────────────────┴──────────┘ # Create a monitor -$ devhelm monitors create --name "Checkout API" --type HTTP --url https://api.example.com/checkout --interval 30 +$ devhelm monitors create --name "Checkout API" --type HTTP --url https://api.example.com/checkout --frequency 60 # Scaffold a config file and validate it $ devhelm init @@ -58,10 +58,10 @@ The CLI resolves credentials in this order: devhelm auth login # Or set a token directly -export DEVHELM_API_TOKEN=sk_live_... +export DEVHELM_API_TOKEN=dh_live_... # Manage multiple environments -devhelm auth context create staging --api-url https://staging-api.devhelm.io --token sk_test_... +devhelm auth context create staging --api-url https://staging-api.devhelm.io --token dh_test_... devhelm auth context use staging devhelm auth context list ``` @@ -113,8 +113,10 @@ DevHelm is designed to work seamlessly with AI coding agents: - **[Agent Skill](https://github.com/devhelmhq/skill)** — structured instructions for Claude Code, Cursor, Codex, and other AI agents ```bash -# Install the MCP server -npm install -g @devhelm/mcp-server +# Install the MCP server (Python package on PyPI) +pip install devhelm-mcp-server +# or, no install required: +uvx devhelm-mcp-server # Or add the skill to your project npx skills add devhelmhq/skill