Skip to content

docs(cli): align preset module lists with actual smpy new behavior #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antosubash merged 1 commit into from
May 13, 2026
Merged

docs(cli): align preset module lists with actual smpy new behavior #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions docs/guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,11 @@ smpy new myapp --preset standard --with background_tasks,file_storage

| Preset | Modules |
|---|---|
| `minimal` | `auth`, `users`, `permissions` |
| `standard` (default) | `minimal` + `dashboard`, `settings`, `feature_flags` |
| `full` | `standard` + `background_tasks`, `file_storage` |
| `minimal` | `auth`, `users` |
| `standard` (default) | `minimal` + `dashboard`, `permissions` |
| `full` | `standard` + `settings`, `feature_flags`, `file_storage`, `background_tasks` |

`simple_module_settings` is also installed as a baseline dependency of every scaffolded host (regardless of preset), so the Settings admin UI is available even in `minimal`. Dependencies between modules are resolved automatically — e.g. `users` always pulls in `auth`.

After scaffolding, `smpy new` runs `uv sync`, `npm install`, and `alembic upgrade head` for you (skip with `--no-install` if you'd rather drive that yourself).

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ smpy new myapp --yes
cd myapp
```

`--yes` accepts the defaults (SQLite, no multi-tenancy, the `standard` preset: `auth`, `users`, `permissions`, `dashboard`, `settings`, `feature_flags`). The CLI runs `uv sync`, `npm install`, and `alembic upgrade head` for you.
`--yes` accepts the defaults (SQLite, no multi-tenancy, the `standard` preset: `auth`, `users`, `dashboard`, `permissions`, plus `settings` as a baseline). The CLI runs `uv sync`, `npm install`, and `alembic upgrade head` for you.

For an interactive run with prompts, drop the `--yes`. For a preset + extras: `smpy new myapp --preset standard --with background_tasks,file_storage --yes`.

Expand Down
Loading