Skip to content

Unified startup CLI and consolidated documentation - #13

Merged
llupRisinglll merged 11 commits into
masterfrom
feat/unified-startup-cli
Jan 1, 2026
Merged

Unified startup CLI and consolidated documentation#13
llupRisinglll merged 11 commits into
masterfrom
feat/unified-startup-cli

Conversation

@llupRisinglll

@llupRisinglll llupRisinglll commented Dec 24, 2025

Copy link
Copy Markdown
Member

Created unified CLI for managing Supabase operations and consolidated all documentation.

What Changed

Renamed start.sh to supabase.sh and restructured as a subcommand-based CLI following official Supabase conventions. All operations now go through a single entry point instead of multiple scripts.

Before:

./start.sh --plan=4gb
./scripts/do-limits.sh stats
./scripts/dev-utils.sh status

After:

./supabase.sh start --plan=4gb
./supabase.sh resources
./supabase.sh container-status

Key Features

Unified interface:

  • Single script handles all operations (start, stop, status, resources, logs, reset)
  • Subcommand structure without -- prefix (matches Supabase CLI style)
  • Named arguments for options (--plan=4gb)
  • Interactive plan menu when no plan specified

Better command clarity:

  • status - Project info (URLs, credentials, keys) with sudo authentication
  • container-status - Docker health
  • resources - CPU/memory usage

Documentation cleanup:

  • Consolidated WORKFLOWS.md into README.md
  • Moved helper scripts to /scripts directory
  • Deduplicated content across DIGITALOCEAN-BENCHMARKS.md and OPTIMIZATION.md
  • Updated all command references throughout docs

Why These Changes

The old approach required users to know which script to use for different operations. The unified CLI provides a consistent interface that's easier to learn and matches the official Supabase CLI patterns users are already familiar with.

Added sudo authentication for the status command since it displays sensitive API keys and passwords.

@llupRisinglll llupRisinglll self-assigned this Dec 24, 2025
@llupRisinglll llupRisinglll added enhancement New feature or request documentation Improvements or additions to documentation automation Automation scripts and workflows labels Dec 24, 2025
Renamed commands:
- stats -> resources (CPU/memory usage)
- status -> container-status (Docker health)

Added new status command to display project info:
- Access URLs (Dashboard, API, Database)
- Credentials (Dashboard, Database)
- API Keys (Anon, Service Role)
- Connection info (PostgreSQL, Kong, Pooler)

This follows official Supabase CLI conventions and provides
clearer separation between different status types.
Require sudo password before displaying sensitive information
including API keys, database passwords, and credentials.

Updated help text and documentation to indicate this requirement.
DIGITALOCEAN-BENCHMARKS.md:
- Update command references to use ./supabase.sh
- Remove reference to deleted WORKFLOWS.md
- Update file list to reflect new structure

OPTIMIZATION.md:
- Remove duplicate service lists (now reference README)
- Remove duplicate resource usage table (now reference README)
- Update testing commands to use unified CLI
- Keep unique re-enabling instructions
@llupRisinglll

Copy link
Copy Markdown
Member Author

@ronhedwigzape , whenever you have time, can you help reviewing and testing it? Thanks!

@ronhedwigzape

Copy link
Copy Markdown
Member

Hi @llupRisinglll , It turns out that the new commands are okay in Mac. The old commands were functioning as usual.

@llupRisinglll

Copy link
Copy Markdown
Member Author

Hi @llupRisinglll , It turns out that the new commands are okay in Mac. The old commands were functioning as usual.

Can I get PR approval?

@ronhedwigzape ronhedwigzape left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@llupRisinglll
llupRisinglll merged commit 62c83ba into master Jan 1, 2026
3 checks passed
@llupRisinglll
llupRisinglll deleted the feat/unified-startup-cli branch January 1, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation Automation scripts and workflows documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants