supacrud

supacrud is an in progress command-line interface tool designed to generate CRUD (Create, Read, Update, Delete) operations for your Supabase database tables in TypeScript projects.

Installation

To install supacrud, make sure you have Node.js and npm installed, then run:

npm install -g supacrud

Usage

After installation, you can use supacrud by running the supacrud command in your terminal:

supacrud [OPTIONS]

Options

• -t, --table <table-name>: Specify the table name to perform CRUD operations on.
• -a, --all: Generate all CRUD operations.
• -c, --create: Generate create operation.
• -r, --read: Generate read operation.
• -u, --update: Generate update operation.
• -d, --delete: Generate delete operation.
• -s, --set-creds: Update your Supabase credentials.

Example

Run supacrud with no options:

supacrud

Specify a table to generate CRUD ops for:

supacrud --table users

Generate create and read ops for a users table:

supacrud -t users -c -r

Generate update and read ops for a users table:

supacrud -t posts -u -d

Generate all CRUD ops for a comments table:

supacrud -t comments -a

Update your Supabase credentials:

supacrud -s

If you don't specify any flags, supacrud will prompt you to choose an operation interactively.

CRUD Operations

supacrud supports the following operations:

1. All: Add Create, Read, Update, Delete Ops for the specified table
2. Create: Add new records to your specified table
3. Read: View existing records and table structure
4. Update: Modify existing records in the table
5. Delete: Remove records from the table

For each table, supacrud generates corresponding .ts files in the data/<table-name>/ directory containing the CRUD operations for that table.

First-Time Setup (current implementation)

When you run supacrud for the first time, it will prompt you to enter your Supabase project URL and API key. These credentials will be stored locally for future use.

In the future, supacrud will infer the Supabase project URL and API key from local storage if supabase login has been run.

Configuration

supacrud stores its configuration in:

~/.config/supacrud/config.json

This file contains your Supabase credentials.

License

This project is licensed under the MIT License