From 32c97136a0d59c71f08ee9604a69eb92f97a3112 Mon Sep 17 00:00:00 2001 From: Alex Bespoyasov Date: Thu, 20 Aug 2026 14:42:11 +0200 Subject: [PATCH] docs: improve readme --- README.md | 88 ++++++++++++++++++++++++++++++++----------------- assets/logo.svg | 3 ++ 2 files changed, 60 insertions(+), 31 deletions(-) create mode 100644 assets/logo.svg diff --git a/README.md b/README.md index e4ce6b3..82fb2bd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ -# Confidence Quickstart +

+ Confidence +

-Interactive CLI wizard for setting up and integrating [Confidence](https://confidence.spotify.com/) with your project. It walks you through authentication, framework detection, SDK installation, MCP server connection, and project onboarding — all from the terminal. +

Confidence Quickstart

+ +

+ Get up and running with Confidence in minutes. One command sets up authentication, installs the right SDK, connects MCP servers, and onboards your AI assistant — so you can start managing feature flags and experiments without leaving your editor. +

+ +

+ Docs + License + npm version +

+ +## Highlights + +- **Zero-to-flags in one command** — run `npx @spotify-confidence/quickstart` and the interactive wizard handles the rest +- **Auto-detects your stack** — React, Next.js, Node, Python, Swift, Kotlin, Java, and Go; installs the matching Confidence SDK +- **Connects your AI assistant** — configures MCP servers and IDE plugins for Claude Code, Cursor, or Codex so your agent can manage flags inline +- **Guided onboarding** — generates project context files that teach your AI assistant how your Confidence setup works +- **Migrating from another platform?** Pair with [Confidence AI Plugins](https://github.com/spotify/confidence-ai-plugins) for one-command migrations from PostHog, Eppo, Statsig, or Optimizely ## Quick Start @@ -10,16 +30,22 @@ npx @spotify-confidence/quickstart Requires Node.js 24+. -## What It Does +## Confidence AI Plugins + +Prefer to manage the integration yourself? [confidence-ai-plugins](https://github.com/spotify/confidence-ai-plugins) provides standalone plugins that give AI agents the ability to manage feature flags, work with documentation, run migrations, and more — without the guided wizard flow. -The wizard guides you through: +## Documentation -1. **System check** — verifies your environment and IDE (Claude Code, Cursor, or Codex) -2. **Authentication** — connects to your Confidence account -3. **Framework detection** — identifies your project's framework (React, Next.js, Node, Python, Swift, Kotlin, Java, Go) -4. **SDK installation** — installs the appropriate Confidence SDK -5. **MCP & plugin setup** — connects Confidence MCP servers and IDE plugins -6. **Project onboarding** — generates context files to help your AI assistant understand your Confidence setup +- [Confidence docs](https://confidence.spotify.com/docs/introduction) +- [SDK integration guides](https://confidence.spotify.com/docs/sdks) +- [Migration guides](https://confidence.spotify.com/docs/migrations/overview) +- [OpenFeature standard](https://openfeature.dev) + +## Community & Support + +Found a bug or have a feature request? [Open an issue](https://github.com/spotify/confidence-cli/issues). + +--- ## Usage @@ -48,9 +74,23 @@ confidence-quickstart [command] [options] During the **project onboarding** step, the wizard spawns your chosen AI agent (Claude Code, Cursor, or Codex) to integrate the Confidence SDK into your project. The spawned agent can read and write files within your project directory — this is required for it to install dependencies, create configuration files, and modify source code. You will be prompted to confirm before this step begins. -## Confidence AI Plugins +## Telemetry + +The wizard collects anonymous usage data (e.g. which steps you complete) to help improve the experience. No personal or project data is collected. + +To opt out: + +```bash +npx @spotify-confidence/quickstart --no-telemetry +``` + +Or set the environment variable: -Prefer to manage the integration process yourself? [confidence-ai-plugins](https://github.com/spotify/confidence-ai-plugins) provides a collection of standalone plugins that give AI agents the ability to more granularly manage feature flags, work with documentation, set up data warehouses for experiments, and more — without the guided wizard flow. +```bash +CONFIDENCE_TELEMETRY=false npx @spotify-confidence/quickstart +``` + +Telemetry is automatically disabled in CI environments and during development. ## Development @@ -64,30 +104,16 @@ pnpm qa # Run all checks (typecheck + lint + test) pnpm build # Build for distribution ``` -## Troubleshooting +### Troubleshooting -### E2E tests fail to install or build +#### E2E tests fail to install or build E2E tests use `node-pty` to drive the TUI in a real terminal. This native module requires platform-specific build tools. If `pnpm install` fails on `node-pty`, install the prerequisites listed at https://github.com/microsoft/node-pty#dependencies. -### E2E tests fail with `posix_spawnp failed` +#### E2E tests fail with `posix_spawnp failed` The stable `node-pty` release (v1.1.0) doesn't ship prebuilt binaries for Node.js v26+. The project uses `node-pty@1.2.0-beta.14` which includes updated Node-API bindings for newer Node versions. If you hit this error on a newer Node version, ensure the beta is installed. On CI with Node 24, the stable release works fine. -## Telemetry +## License -The wizard collects anonymous usage data (e.g. which steps you complete) to help improve the experience. No personal or project data is collected. - -To opt out: - -```bash -npx @spotify-confidence/quickstart --no-telemetry -``` - -Or set the environment variable: - -```bash -CONFIDENCE_TELEMETRY=false npx @spotify-confidence/quickstart -``` - -Telemetry is automatically disabled in CI environments and during development. +[Apache License 2.0](./LICENSE) diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..2bc1c8b --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,3 @@ + + +