FAQ

The questions that come up most often from people getting started with the Fayz SDK.

Is it free? What's the license?

The public SDK packages ship under the MIT license — free to use, including commercially. The hosted Fayz platform is a separate product; the SDK itself you can install and run at no cost.

Can I use the SDK without the Fayz platform?

Partly, and it's worth being clear about the limit. You can install @fayz-ai/cli, generate apps, edit the manifest, wire plugins and plan migrations — all of that is public. But the app-runtime that renders the admin shell from the manifest ships with the platform, so locally against the public SDK you still see a placeholder screen instead of the assembled app. See Troubleshooting and The two paths to understand exactly where that boundary sits today.

How does versioning work before 1.0?

Each package versions on its own in 0.x. While we're pre-1.0, a minor release can change behavior — don't treat 0.x as strict semver. Read the Changelog notes before upgrading, and pin versions in production. The full policy is in Versioning.

Can I build my own plugin?

Yes. The recommended path is the incubator: a plugin that lives in your app's src/plugins/, following the same contract as catalog plugins, owning its own database and injecting UI into the SDK's surfaces. It can mature locally and, if it makes sense, graduate to the marketplace. See Building plugins.

How do I contribute to the core?

For now, core development is led by Faya Labs. If you want to propose a change, fix something or build alongside us, get in touch through the Community — describe the case and we'll take it from there. There's no open public pull request flow today.

What's the relationship between Fayz and Faya Labs?

Fayz is the product — the SDK, the plugins, the platform. Faya Labs is who builds and maintains Fayz, and the community around it. When you read "Faya Labs decided X", it's about the direction of the Fayz product.

Do I need Supabase to get started?

No. Every generated app starts on backend.provider: "mock", which runs on sample data with zero configuration — that's mock-first mode. You only connect a real Supabase when you want persistent data; then you fill in .env.local and run fayz db apply. Start on mock, migrate when you need to. Step-by-step instructions are in Real data with Supabase.

What can I publish as a static site?

The generated front end is a Vite app, so the build is a static bundle you can publish on any file host. Anything that needs a backend (real data via Supabase, migration tooling) still requires the corresponding credentials. See Static deploy.