Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,20 @@ docker compose logs -f nginx

### Installation & Setup

Installation is handled by the `saucebase` global Composer CLI, not an in-app artisan command:

```bash
# Quick install (recommended for new projects)
php artisan saucebase:install

# Advanced options
php artisan saucebase:install --no-docker # Skip Docker setup
php artisan saucebase:install --no-ssl # Skip SSL generation
php artisan saucebase:install --force # Force reinstallation
php artisan saucebase:install --no-interaction # CI/CD mode
# New project — installs PHP/Composer if missing, scaffolds, and installs
curl -fsSL https://install.saucebase.dev | bash

# Or, with PHP/Composer already installed
composer global require saucebase/installer
saucebase new my-app

# Re-run install against an existing checkout
saucebase install --driver=docker --ssl=no
saucebase install --driver=native --force
saucebase install --driver=native --modules=none --force # CI/CD mode
```

### Module Management
Expand Down
10 changes: 5 additions & 5 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Saucebase is a modular Laravel SaaS starter kit. Modules are installed via Composer and owned directly in the repository (copy-and-own).

**Core message:** The foundation is built. Focus on your product. See [`docs/CLAUDE.md`](../docs/CLAUDE.md) → _Saucebase Philosophy_ for tone and value-proposition guidance.
**Core message:** The foundation is built. Focus on your product. See the [Design Philosophy](https://saucebase-dev.github.io/docs/architecture/philosophy) doc for tone and value-proposition guidance.

**Stack:** Laravel 13, PHP 8.4+, Vue 3 Composition API, TypeScript 5.8, Inertia.js 3, Tailwind CSS 4, Vite 6.4, Filament 5 admin panel, Docker (Nginx, MySQL 8, Redis, Mailpit)

Expand Down Expand Up @@ -45,9 +45,9 @@ composer remove saucebase/auth # Removes module
php artisan module:generate-types ModuleName # single module
php artisan module:generate-types # all enabled modules

# Framework selection (contributor dev workflow) — see Architecture > Frontend for gotchas
php artisan saucebase:stack {vue|react} --dev # Switch active framework in dev mode (keeps both dirs)
php artisan saucebase:stack {vue|react} --reset # Reset to clean state (removes frontend.json)
# Framework selection (contributor dev workflow, via the global `saucebase` CLI) — see Architecture > Frontend for gotchas
saucebase stack {vue|react} --dev # Switch active framework in dev mode (keeps both dirs)
saucebase stack {vue|react} --reset # Reset to clean state (removes frontend.json)
```

## Architecture
Expand Down Expand Up @@ -89,7 +89,7 @@ Uses `internachi/modular`. Modules are Composer packages installed into `modules
- `"dev": true` — contributor mode: both `vue/` and `react/` dirs kept, thin entry point passthroughs generated
- `"dev"` absent — end-user install: selected framework flattened to `resources/js/`, other dir deleted (one-time)

**`saucebase:stack` modes:**
**`saucebase stack` modes:**
- `--dev` — contributor workflow: copies config files, creates entry passthroughs, keeps both framework dirs
- _(no flag)_ — end-user install: flattens one framework, deletes the other. Throws if `frontend.json` already exists
- `--reset` — restores git-tracked files, removes `frontend.json`
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The **recommended** way to install Saucebase is by running the command below:
curl -fsSL https://install.saucebase.dev | bash
```

The setup screen will guide you through choosing a frontend framework and installing your first modules.
The CLI installs PHP/Composer if needed, then guides you through choosing a frontend framework and installing your first modules.

Looking for help? Start with our [Getting Started](https://saucebase-dev.github.io/docs/) guide.

Expand Down