diff --git a/README.md b/README.md index 9f7b0bd..14c4b5b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,44 @@ -# @smooai/testing + -Smoo AI Testing SDK — CLI and library for interacting with the Smoo AI Testing API. +

+ Smoo AI +

-Report test results, manage test runs, cases, environments, and deployments. +

@smooai/testing

-## Installation +

+ CLI and library for the Smoo AI Testing API — report test results and manage runs, cases, environments, and deployments. +

+ +

+ npm + downloads + Smoo AI + license + TypeScript +

+ +

+ Features · + Install · + Usage · + CLI · + Platform +

+ +--- + +> Report test results to Smoo AI and manage your test program from the command line or in code. Pipe CTRF reports straight from CI, or drive runs, cases, environments, and deployments programmatically. + +## ✨ Features + +- Report CTRF test results from any test runner, straight from CI +- Manage test runs, cases, environments, and deployments +- Use it as a CLI or as a typed TypeScript library +- `--json` output on every command (auto-enabled when piped) +- M2M auth via `login` or environment variables for CI/CD + +## 📦 Install ```bash npm install @smooai/testing @@ -12,9 +46,9 @@ npm install @smooai/testing pnpm add @smooai/testing ``` -## Quick Start +## 🚀 Usage -### CLI: Report test results +### CLI: report test results ```bash # Authenticate @@ -29,7 +63,7 @@ npx @smooai/testing runs report ctrf-report.json \ --name "PR #42 Tests" ``` -### Library: Programmatic usage +### Library: programmatic usage ```typescript import { SmooTestingClient } from '@smooai/testing'; @@ -51,7 +85,7 @@ const runs = await client.listRuns({ status: 'failed' }); const envs = await client.listEnvironments(); ``` -## CLI Commands +## 📖 CLI commands ### Authentication @@ -61,7 +95,7 @@ smooai-testing logout smooai-testing status ``` -### Test Runs +### Test runs ```bash smooai-testing runs create --name "Run Name" [--environment prod] [--tool vitest] @@ -71,7 +105,7 @@ smooai-testing runs update --status completed smooai-testing runs report [--name "Run"] [--environment prod] ``` -### Test Cases +### Test cases ```bash smooai-testing cases create --title "Test login flow" [--priority high] [--tags "auth,e2e"] @@ -100,7 +134,7 @@ smooai-testing deployments update --status success smooai-testing deployments delete ``` -## JSON Output +### JSON output All commands support `--json` for machine-readable output: @@ -110,7 +144,7 @@ smooai-testing runs list --json | jq '.data[].id' JSON mode is auto-enabled when output is piped (no TTY). -## CI/CD Usage +## 🤖 CI/CD usage Set environment variables instead of using `login`: @@ -133,7 +167,7 @@ GitHub Actions example: SMOOAI_ORG_ID: ${{ secrets.SMOOAI_ORG_ID }} ``` -## Development +## 🔧 Development ```bash pnpm install @@ -145,6 +179,23 @@ pnpm format # Format code pnpm check-all # All checks (CI parity) ``` -## License +## 🧩 Part of Smoo AI + +@smooai/testing is part of the [Smoo AI](https://smoo.ai) platform — an AI-powered business platform with AI built into every product. It's the client for our hosted Testing API; the rest of the platform shares the same open-source toolbox. + +- [@smooai/utils](https://github.com/SmooAI/utils) — foundational TypeScript utilities +- [@smooai/logger](https://github.com/SmooAI/logger) — contextual structured logging +- [@smooai/fetch](https://github.com/SmooAI/fetch) — typed HTTP with retries +- [@smooai/config](https://github.com/SmooAI/config) — typed config, secrets, and feature flags + +Browse everything at [github.com/SmooAI](https://github.com/SmooAI). + +## 📄 License MIT + +--- + +

+ Built by Smoo AI — AI built into every product. +