stably 4.0.2 → 4.0.3

package/README.md

@@ -1,78 +1,37 @@
-# Stably CLI
-
-## Local Development
-
-### Prerequisites
-
-- Node.js v20+
-- pnpm v10+
-
-### Build
-
-From the monorepo root:
-
-```bash
-pnpm --filter stably build
-```
-
-Or from this directory:
-
-```bash
-pnpm build
-```
-
-### Run Locally (without global link)
-
-```bash
-# Using tsx (dev mode, no build required)
-pnpm dev
-
-# Using built dist
-pnpm start
-# or
-node dist/index.js
-```
+<p align="center">
+  <a href="https://stably.ai">
+    <img src="./logo/logo-white-with-bg.png" height="96">
+    <h3 align="center">Stably</h3>
+  </a>
+</p>
+
+<p align="center">
+  Code. Ship. <s>Test.</s>
+</p>
+
+<p align="center">
+  <a href="https://docs.stably.ai/"><strong>Documentation</strong></a> ·
+  <a href="https://stably.ai/"><strong>Homepage</strong></a>
+</p>
+<br/>
 
-### Global Link for Testing
-
-To test the CLI as if it were installed globally:
-
-**1. Build the CLI:**
-
-```bash
-cd /path/to/noqa
-pnpm --filter stably build
-```
-
-**2. Link globally:**
-
-```bash
-cd packages/cli
-PNPM_HOME="$HOME/Library/pnpm" PATH="$PNPM_HOME:$PATH" pnpm link --global
-```
-
-**3. Run from anywhere:**
-
-```bash
-PNPM_HOME="$HOME/Library/pnpm" PATH="$PNPM_HOME:$PATH" stably --help
-```
+# Stably CLI
 
-**Tip:** Add this to your shell profile (`.zshrc` / `.bashrc`) to avoid typing the env vars:
+This package extends Playwright to add new AI functionality.
+To get started quickly, please see [AI-assisted setup guide](https://docs.stably.ai/getting-started/sdk-setup-guide). Otherwise continue to read below.
 
-```bash
-export PNPM_HOME="$HOME/Library/pnpm"
-export PATH="$PNPM_HOME:$PATH"
+## Installation
+```shell
+npm i -g stably
 ```
 
-### Unlink
-
-To remove the global link:
-
-```bash
-rm -f "$HOME/Library/pnpm/stably"
-```
+> 🎭 **Note**  
+> We let you bring your own Playwright version.
+> This does mean that Playwright must first be setup (our CLI can help you do that)
 
-### Notes
+## Usage
+Below is a short list of common commands. For a complete list, please use `stably --help`
 
-- Workspace dependencies (`@stablyai/internal-api-client`, `@stablyai/agent-hooks`, etc.) are bundled into the dist via `noExternal` in `tsup.config.ts`
-- If you add new workspace dependencies, add them to the `noExternal` array in `tsup.config.ts`
+  * `npx stably`: This starts our REPL which will help with test creation or modifications
+  * `npx stably test`: Use this to run tests locally or in the CI
+  * `npx stably --help`: Will print full list of commands

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "stably",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "packageManager": "pnpm@10.24.0",
-  "description": "Stably CLI",
+  "description": "AI-powered E2E Playwright testing CLI. Stably can understand your codebase, edit/run tests, and handle complex test scenarios for you.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "logo/logo-white-with-bg.png"
   ],
   "bin": {
     "stably": "dist/index.js"
@@ -24,9 +25,38 @@
     "format": "prettier --write \"src/**/*.ts\""
   },
   "keywords": [
+    "ai",
+    "testing",
+    "playwright",
+    "automation",
+    "e2e",
+    "end-to-end",
+    "qa",
+    "test-automation",
+    "browser-testing",
+    "ai-testing",
+    "llm",
+    "natural-language",
+    "codegen",
+    "test-generation",
+    "web-testing",
+    "ui-testing",
+    "regression-testing",
     "cli"
   ],
-  "author": "",
+  "homepage": "https://stably.ai",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stablyai/stably"
+  },
+  "bugs": {
+    "url": "https://github.com/stablyai/stably/issues"
+  },
+  "license": "UNLICENSED",
+  "author": "Stably AI <support@stably.ai>",
+  "engines": {
+    "node": ">=20"
+  },
   "dependencies": {
     "@anthropic-ai/claude-agent-sdk": "^0.1.62",
     "@clack/prompts": "^0.11.0",