Quick Start Guide

Kick off a new Weldr workspace in under an hour. This walkthrough assumes you are using the hosted Free Cloud experience; self-hosting tips live in the installation appendix.

0. Get Access

Request an invite at weldr.dev or ask the product team to add you to the beta cohort.

Check your inbox for the magic-link email and log in at https://app.weldr.dev.

> During beta, app.weldr.dev resolves to the same deployment as weldr.dev. The separate host will roll out as we split the marketing and app surfaces.

Create or join a workspace. (Each workspace can host multiple apps/chats.)

1. Start a Conversation

• Click New App Chat.

• Describe the problem you want to solve, e.g.

  I need a subscription analytics dashboard for B2B SaaS.
  - Organizations own multiple products.
  - Products stream usage events (MAU, API calls, seats).
  - Finance wants monthly revenue rollups and churn flags.

• Watch entities, relationships, and workflows emerge in the right-hand panel while the live preview boots.

2. Refine the Model Together

• Reply with clarifying details, business rules, or UI expectations.

• Invite team members to the chat so PMs/design can tweak copy or flows in real time.

• Flip between phases (Discover → Clarify → Propose → Confirm) using the timeline above the composer. When readiness passes ~85%, Weldr prompts you to materialize the app.

3. Choose Ownership Modes

Open the Ownership sidebar.

Leave commodity surfaces (database, auth, scaffolding) in Managed mode.

Switch critical pieces (pricing, workflows, adapters) to Extended or Ejected to unlock custom logic and contract validation.

Regenerate. The preview updates, preserving every @custom block and checking ejected contracts for type compatibility.

4. Preview, Test, and Iterate

• Use the live app directly in the browser—forms are functional, database writes hit the managed Postgres instance, and server actions run in WebContainers.

• Toggle dark mode, inspect generated files, and capture shareable previews for stakeholders.

• Need to revert a change? Use the activity timeline to roll back to an earlier message and regenerate.

5. Export to Code

When you are ready to merge into your own repository:

# Authenticate once in the hosted workspace (Settings → API Tokens)
weldr login

# Sync code locally
git clone git@github.com:your-org/your-app.git
yarn install # or pnpm install
weldr sync <chat-id> --out ./generated

# Inspect contracts & run tests
weldr contracts check
pnpm test

Commit the generated changes alongside your custom code. From here the app behaves like any other Next.js project.

Troubleshooting

• Preview fails to boot – Check the status banner; if the queue is busy, try again in a few minutes or contact support.

• Contracts mismatch – Run weldr contracts check to see which export drifted; update your ejected module or adjust the manifest.

• Need more capacity – Pro tier raises regen limits and adds priority preview slots. See the pricing page or reach out in-product.

Ready for deeper configuration? Head to the installation guide for self-hosting instructions or explore progressive ownership for advanced manifest patterns.