@allstak/wizard
v0.1.19
Published
AllStak SDK installation and configuration wizard. Lists public Stable runtimes, fully/assisted-wires JS, React, and Next.js, and keeps manual-light server SDK setup honest.
Maintainers
Readme
@allstak/wizard
One command to install and configure AllStak in any project.
npx @allstak/wizard -i reactFeatures
- Auto-detection -- detects your framework and wires the right SDK automatically
- Safe mutations -- every file change is snapshotted and fully reversible
- Doctor -- diagnoses connectivity, config, and integration health in seconds
- Dry-run mode -- preview every change before writing a single file
- CI-friendly -- supports API key auth and
--jsonoutput for automation - Self-hosted ready -- configurable API, ingest, and dashboard endpoints
Quickstart
# 1. Authenticate
npx @allstak/wizard login
# 2. Install an SDK into your project
npx @allstak/wizard -i react
# 3. Verify the setup
npx @allstak/wizard doctorThe wizard installs the SDK, patches your entry files, and configures source maps. Run doctor at any time to validate the integration.
Supported Integrations
| Integration | Runtime | Wizard |
|---|---|---|
| js (JavaScript / TypeScript) | Stable | Stable |
| react (Vite or CRA) | Stable | Stable |
| react-native (Expo + bare RN) | Stable | Setup guide |
| next (13+, App + Pages router) | Beta | Beta |
| java (Spring Boot) | Beta | Setup guide |
| python | Beta | Setup guide |
| go | Beta | Setup guide |
Run npx @allstak/wizard list to see all available integrations.
Commands
| Command | Description |
|---|---|
| login | Authenticate via email OTP (with optional TOTP) |
| init -i <integration> | Install and configure an SDK |
| doctor | Run diagnostic checks on your setup |
| repair -i <integration> | Fix a broken integration in place |
| uninstall -i <integration> | Cleanly remove an SDK |
| restore list / apply / diff | Browse and restore file snapshots |
| config validate | Check your project config file |
| whoami | Show the current authenticated user |
All commands support --dry-run, --json, and --debug. See npx @allstak/wizard --help for the full reference.
Configuration
Create an optional allstak.config.ts (or .mjs, .js, .cjs, .json) to avoid repeating flags:
import { defineConfig } from '@allstak/wizard/config';
export default defineConfig({
schemaVersion: 1,
organization: 'my-org',
project: 'my-project',
environment: 'production',
release: process.env.GIT_SHA,
sourceMaps: { enabled: true, ignore: ['node_modules'] },
});Precedence: CLI flag > environment variable > config file > built-in default.
Full reference: docs/config.md
Doctor
Doctor runs a fixed sequence of checks -- auth, reachability, config, integration, event ingest, release linkage, and source maps -- and reports pass, warn, fail, or skip with an actionable fix for each.
# Offline checks only
npx @allstak/wizard doctor
# Full live verification (sends a test event and confirms ingestion)
npx @allstak/wizard doctor --live-probe \
--api-key ask_live_... --project-id <uuid>Full reference: docs/doctor.md
Privacy
The wizard collects minimal anonymous usage telemetry (version, command, OS family, outcome). It never collects API keys, file paths, source code, or personally identifiable information.
Opt out with any of:
npx @allstak/wizard --no-telemetry ...
ALLSTAK_WIZARD_TELEMETRY=0 npx @allstak/wizard ...Full policy: docs/privacy.md
Self-Hosted Deployments
Point the wizard at your own AllStak instance:
npx @allstak/wizard -i react \
--host https://api.allstak.example \
--ingest-host https://api.allstak.example \
--dashboard-host https://app.allstak.exampleOr set selfHosted in your config file. See docs/config.md for details.
Links
License
Apache-2.0 -- see LICENSE.
