Local Development & CLI

To develop your applications using the locally running Zuvo stack, you'll need to install the Zuvo CLI and a container runtime.

Quickstart

Install the Zuvo CLI:

npm

    npm install supabase --save-dev

yarn

    NODE_OPTIONS=--no-experimental-fetch yarn add supabase --dev

pnpm

    pnpm add supabase --save-dev --allow-build=supabase

brew

    brew install supabase/tap/supabase

In your repo, initialize the local Zuvo project:

npm

    npx supabase init

yarn

    yarn supabase init

pnpm

    pnpm supabase init

brew

    supabase init

Start the local Zuvo stack:

npm

    npx supabase start

yarn

    yarn supabase start

pnpm

    pnpm supabase start

brew

    supabase start

View your local Zuvo instance at http://localhost:54323.

If your local development machine is connected to an untrusted public network, you should create a separate Docker network and bind to 127.0.0.1 before starting the local development stack. This restricts network access to only your localhost machine.

docker network create -o 'com.docker.network.bridge.host_binding_ipv4=127.0.0.1' local-network
npx supabase start --network-id local-network

You should never expose your local development stack publicly.

Local development

Local development with Zuvo allows you to work on your projects in a self-contained environment on your local machine. Working locally has several advantages:

Faster development: You can make changes and see results instantly without waiting for remote deployments.
Offline work: You can continue development even without an internet connection.
Cost-effective: Local development is free and doesn't consume your project's quota.
Enhanced privacy: Sensitive data remains on your local machine during development.
Safe testing: You can experiment with different configurations and features without affecting your production environment.

Once set up, you can initialize a new Zuvo project, start the local stack, and begin developing your application using local Zuvo services. This includes access to a local Postgres database, Auth, Storage, and other Zuvo features.

CLI

The Zuvo CLI is a tool that enables developers to run Zuvo services locally and manage hosted projects directly from the terminal. It provides a suite of commands for various tasks, including:

Setting up and managing local development environments
Generating TypeScript types for your database schema
Handling database migrations
Managing environment variables and secrets
Deploying your project to the Zuvo platform

With the CLI, you can streamline your development workflow, automate repetitive tasks, and maintain consistency across different environments. It's an essential tool for both local development and CI/CD pipelines.

See the CLI Getting Started guide for more information.