superslate 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +5 -0
- package/README.md +62 -0
- package/dist/cli.js +2172 -0
- package/package.json +46 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
All rights reserved.
|
|
2
|
+
|
|
3
|
+
This bootstrap package does not contain or grant access to the superslate Product Source. Use of
|
|
4
|
+
the bootstrapper and any source obtained through it requires an authorized entitlement and remains
|
|
5
|
+
subject to the terms supplied with the applicable order.
|
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# superslate
|
|
2
|
+
|
|
3
|
+
Create a buyer-owned, production-oriented SaaS application from a licensed superslate release.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
pnpm dlx superslate@latest my-saas
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
The same package works with Bun:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
bunx superslate@latest my-saas
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
It can also be launched through npm with `npx superslate@latest my-saas`. The launcher does not
|
|
16
|
+
change the generated toolchain: superslate always installs the canonical `pnpm-lock.yaml` with pnpm.
|
|
17
|
+
This keeps local development, CI, upgrades, and support on one reproducible package-manager path.
|
|
18
|
+
|
|
19
|
+
The CLI guides you through the application name, brand, dependency installation, Git initialization,
|
|
20
|
+
and whether to start local development immediately. It derives the internal workspace namespace from
|
|
21
|
+
the brand, generates a unique Better Auth secret locally, selects an available local Postgres port,
|
|
22
|
+
and refuses to overwrite a non-empty directory. The namespace groups private monorepo packages and
|
|
23
|
+
does not need to exist on npm.
|
|
24
|
+
|
|
25
|
+
## Source access
|
|
26
|
+
|
|
27
|
+
The npm package is a public bootstrapper; it does not contain the paid foundation source. Before
|
|
28
|
+
running it:
|
|
29
|
+
|
|
30
|
+
1. accept the private GitHub repository invitation included with your superslate entitlement;
|
|
31
|
+
2. install [GitHub CLI](https://cli.github.com/); and
|
|
32
|
+
3. authenticate once with `gh auth login`.
|
|
33
|
+
|
|
34
|
+
The CLI never asks you to paste a GitHub token. Its version is bound to the matching immutable
|
|
35
|
+
source tag: `superslate@1.2.3` downloads `v1.2.3`. It downloads the release archive, SHA-256 file,
|
|
36
|
+
and manifest through your existing GitHub CLI session and verifies both records before extracting
|
|
37
|
+
source.
|
|
38
|
+
|
|
39
|
+
## Options
|
|
40
|
+
|
|
41
|
+
```text
|
|
42
|
+
--scope <namespace> Advanced override for the workspace namespace derived from the brand
|
|
43
|
+
--brand <name> Override the display name derived from the app name
|
|
44
|
+
--no-install Generate without installing dependencies
|
|
45
|
+
--no-git Generate without initializing Git
|
|
46
|
+
--start Start Postgres and the development servers after creation
|
|
47
|
+
--no-start Create the application without starting it
|
|
48
|
+
--yes Accept all recommended defaults
|
|
49
|
+
--from <path> Use a local source checkout for maintainer or pre-release testing
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
When automatic startup is selected, Ctrl+C stops the application development servers. The detached
|
|
53
|
+
Postgres container remains available for the next run; stop it later with `docker compose down` from
|
|
54
|
+
the generated directory.
|
|
55
|
+
|
|
56
|
+
For reproducible automation, select an exact CLI version instead of `latest`:
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
pnpm dlx superslate@1.2.3 my-saas --yes --no-start
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Product information: [superslate.dev](https://superslate.dev)
|