Installation & Setup

Learn how to install and set up ByteMason for your development environment.

Prerequisites

Before installing ByteMason, ensure you have:

• Python 3.10 or higher
• A Supabase account (free tier works great!)

Installation

Install ByteMason using uv:

uv pip install bytemason

Initial Setup

1. Verify Installation

berry --version

2. Configure Supabase Credentials

You’ll need these when running database commands:

• Project URL
• Service Role Key (found in Project Settings > API)

Your First Project

1. Create a New Project

berry new my-first-app
cd my-first-app

2. Generate Specification

berry plan "Create a todo app with user authentication, categories, and due dates"

3. Set Up Database

berry db setup ./spec/specification.json
berry db push

4. Generate Code

berry code ./spec/specification.json

5. Start Development Server

npm install
npm run dev

What’s Next?

• Explore Core Concepts to understand how ByteMason works
• Check out our Guides for detailed tutorials
• Learn about all available commands in the API Reference