Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 57 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# Confidence Quickstart
<p align="center">
<img src="assets/logo.svg" alt="Confidence" width="120" />
</p>

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.
<h1 align="center">Confidence Quickstart</h1>

<p align="center">
Get up and running with <a href="https://confidence.spotify.com">Confidence</a> 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.
</p>

<p align="center">
<a href="https://confidence.spotify.com/docs/introduction"><img alt="Docs" src="https://img.shields.io/badge/docs-confidence.spotify.com-6E56CF"></a>
<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue"></a>
<a href="./CHANGELOG.md"><img alt="npm version" src="https://img.shields.io/npm/v/@spotify-confidence/quickstart?color=informational"></a>
</p>

## 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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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)
3 changes: 3 additions & 0 deletions assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.