Interactive terminal wizard for setting up your local Factorial development environment.
Replaces the legacy welcome.sh shell script with a polished TUI built with Ink (React for the terminal). It guides new developers through 13 setup tasks across 6 screens, running tasks in parallel where dependencies allow.
npx --yes github:factorialco/welcome#v1Or clone and run locally:
git clone git@github.com:factorialco/welcome.git
cd welcome
npm install
npm start| Screen | Purpose |
|---|---|
| Welcome | Overview of all 13 tasks |
| Identity | Git name, email, SSH key setup |
| Tools | Version manager (mise/asdf) and editor (Cursor/VS Code) |
| Services | Ngrok tunnel, Cognito authentication, DB restore options |
| Review | Summary of chosen configuration before install |
| Install | Parallel task execution with live progress |
- System packages -- Homebrew, Brewfile (30+ formulae and casks), direnv
- Docker -- Colima, architecture-aware config (vz/virtiofs on Apple Silicon)
- Git identity -- SSH key generation, GitHub SSO authorization
- Clone repository --
factorialco/factorialto~/code/factorial, git perf settings - Version manager -- mise or asdf with Ruby, Node.js, Python, Rust plugins
- AWS credentials -- SSO login with
developmentprofile - Secrets -- Retrieve env vars from AWS Secrets Manager
- Hosts file -- 27
*.local.factorial.deventries in/etc/hosts - Editor extensions -- 23+ VS Code/Cursor extensions + custom
.vsixpackages - Ngrok tunnel -- Domain and authtoken configuration
- Cognito -- KMS, IAM Role, Lambda, User Pool, Client, domain provisioning
- Dev environment -- pnpm/yarn install, bundle install, docker-compose, DB setup
- Agent skills -- 5 skill repos for AI coding assistants
Tasks run in parallel tiers based on their dependency graph -- independent tasks start as soon as their prerequisites finish.
- macOS
- Node.js >= 18
