Rye Installer
Workflow
- •Validate target database connection (
DATABASE_URL) and target profiles (crm,pm, or none). - •Run
./scripts/install.sh --profiles ...to apply migrations in order. - •Optionally run
./scripts/install.sh --seedfor quickstart data. - •Run
./scripts/verify.shto validate required objects and policies. - •Run
./scripts/conformance.shfor gate checks.
Commands
- •Core only:
./scripts/install.sh --profiles '' - •Core + CRM:
./scripts/install.sh --profiles crm - •Core + PM:
./scripts/install.sh --profiles pm - •Core + CRM + PM:
./scripts/install.sh --profiles crm,pm - •Full checks:
./scripts/conformance.sh
Post-Install
After install, run SELECT rye_catalog() to confirm the instance is ready and see what's connected.
Notes
- •Target PostgreSQL 15+.
- •Rye installs alongside existing tables. It does not modify them.
- •Use
link_record()to connect existing domain table rows to the graph. - •Use
track_table()to attach CDC triggers for change tracking. - •Assertion updates are function-only; verify this via
./scripts/verify.shand security tests. - •Do not edit migration order in
schema/migrationswithout versioning and tests. - •If migrations fail partway, fix the root cause and re-run
./scripts/migrate.sh.