Skip to content

Commit be0b071

Browse files
committed
chore: rename public command references to stackfoundry
Prefer the stackfoundry command in docs, examples, package scripts, and generated registry guidance while keeping internal implementation paths unchanged.
1 parent d940110 commit be0b071

127 files changed

Lines changed: 190 additions & 190 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -108,27 +108,27 @@ pnpm registry:presets
108108
pnpm stackfoundry add preset next-saas --target ./my-app --dry-run
109109
```
110110

111-
## CLI
111+
## StackFoundry Command
112112

113-
The CLI intentionally stays on Node + pnpm. It is a small registry/install engine, not an interactive component wizard.
113+
The `stackfoundry` command intentionally stays on Node + pnpm. It is a small registry/install engine, not an interactive component wizard.
114114

115115
```bash
116-
pnpm cli categories
117-
pnpm cli list --category billing
118-
pnpm cli list --status experimental
119-
pnpm cli search webhook
120-
pnpm cli info stripe-billing
121-
pnpm cli add api-keys --target ./my-app --dry-run
122-
pnpm cli diff api-keys --target ./my-app
123-
pnpm cli build
124-
pnpm cli doctor
116+
pnpm stackfoundry categories
117+
pnpm stackfoundry list --category billing
118+
pnpm stackfoundry list --status experimental
119+
pnpm stackfoundry search webhook
120+
pnpm stackfoundry info stripe-billing
121+
pnpm stackfoundry add api-keys --target ./my-app --dry-run
122+
pnpm stackfoundry diff api-keys --target ./my-app
123+
pnpm stackfoundry build
124+
pnpm stackfoundry doctor
125125
```
126126

127-
Why Node instead of Bun or a larger CLI framework:
127+
Why Node instead of Bun or a larger command framework:
128128

129129
- the repository already targets Node `>=22 <25`
130130
- Vercel builds use Node and pnpm cleanly
131-
- the CLI surface is validation, discovery, install, diff, and build
131+
- the command surface is validation, discovery, install, diff, and build
132132
- avoiding another runtime keeps module consumption simpler
133133

134134
## Registry Model
@@ -227,7 +227,7 @@ pnpm build:web
227227

228228
```text
229229
apps/
230-
cli/ # StackFoundry CLI
230+
cli/ # StackFoundry command source
231231
web/ # public site and registry host
232232
docs/ # product, registry, and maintainer docs
233233
examples/ # reproducible install walkthroughs
@@ -258,7 +258,7 @@ See [`docs/repository.md`](./docs/repository.md) for ownership rules.
258258

259259
## Status
260260

261-
StackFoundry is experimental. The registry, CLI, public registry output, and website are active. Module APIs and file targets can still change while the registry is being shaped.
261+
StackFoundry is experimental. The registry, command, public registry output, and website are active. Module APIs and file targets can still change while the registry is being shaped.
262262

263263
## Contributing
264264

apps/cli/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# StackFoundry CLI
1+
# StackFoundry Command
22

3-
The CLI is the local install engine for StackFoundry registry modules.
3+
The `stackfoundry` command is the local install engine for StackFoundry registry modules.
44

55
## Responsibilities
66

@@ -23,18 +23,18 @@ Shared logic is imported through workspace package aliases:
2323
## Useful Commands
2424

2525
```bash
26-
pnpm cli list
27-
pnpm cli categories
28-
pnpm cli list --category billing
29-
pnpm cli search webhook
30-
pnpm cli info stripe-billing
31-
pnpm cli presets
32-
pnpm cli doctor
33-
pnpm cli build
34-
pnpm cli add api-keys --target /tmp/app --dry-run
35-
pnpm cli add preset provider-adapters --target /tmp/app --dry-run
36-
pnpm cli add https://stackfoundry.dev/r/api-keys.json --target /tmp/app --dry-run
37-
pnpm cli diff api-keys --target /tmp/app
26+
pnpm stackfoundry list
27+
pnpm stackfoundry categories
28+
pnpm stackfoundry list --category billing
29+
pnpm stackfoundry search webhook
30+
pnpm stackfoundry info stripe-billing
31+
pnpm stackfoundry presets
32+
pnpm stackfoundry doctor
33+
pnpm stackfoundry build
34+
pnpm stackfoundry add api-keys --target /tmp/app --dry-run
35+
pnpm stackfoundry add preset provider-adapters --target /tmp/app --dry-run
36+
pnpm stackfoundry add https://stackfoundry.dev/r/api-keys.json --target /tmp/app --dry-run
37+
pnpm stackfoundry diff api-keys --target /tmp/app
3838
```
3939

4040
## Quality Gate

apps/web/app/docs/page.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { Metadata } from "next";
33
export const metadata: Metadata = {
44
title: "Docs",
55
description:
6-
"Install production SaaS modules as editable source code with StackFoundry's registry, CLI, presets, and provider adapters.",
6+
"Install production SaaS modules as editable source code with StackFoundry's registry, command, presets, and provider adapters.",
77
alternates: {
88
canonical: "/docs",
99
},
@@ -445,7 +445,7 @@ export default function DocsPage() {
445445
<span className="docs-brand-chip">Docs</span>
446446
</a>
447447
<div className="docs-search" aria-hidden="true">
448-
<span>Search docs, modules, CLI</span>
448+
<span>Search docs, modules, command</span>
449449
<kbd></kbd>
450450
<kbd>K</kbd>
451451
</div>
@@ -560,9 +560,9 @@ export default function DocsPage() {
560560
2. Add to an existing app <Anchor id="install-existing" />
561561
</h2>
562562
<p>
563-
Existing apps should start with a dry run. The CLI resolves registry dependencies,
564-
prints the proposed file changes, shows env notes, and leaves the review decision with
565-
you. After install, the source is yours to edit like any other code.
563+
Existing apps should start with a dry run. The StackFoundry command resolves registry
564+
dependencies, prints the proposed file changes, shows env notes, and leaves the review
565+
decision with you. After install, the source is yours to edit like any other code.
566566
</p>
567567
<CodeBlock label="terminal">{`$ pnpm stackfoundry add stripe-billing --target ./my-app --dry-run
568568
· resolving registry dependency drizzle-postgres

docs/registry-compat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The goal is to publish production SaaS modules as editable source: a registry it
66

77
## Install a StackFoundry Block
88

9-
With the StackFoundry CLI:
9+
With the StackFoundry command:
1010

1111
```bash
1212
pnpm stackfoundry add https://stackfoundry.dev/r/api-keys.json --target ./my-app
@@ -39,7 +39,7 @@ pnpm stackfoundry add http://localhost:3000/r/api-keys.json --target /tmp/app
3939
- Internal module dependencies are emitted as full `https://stackfoundry.dev/r/<dependency>.json` registry URLs.
4040
- Env requirements are emitted as `envVars` and retained in `meta.env`.
4141
- Module and shared technology skills are emitted as `maintenanceSkills` so registry URL installs include maintenance guidance.
42-
- StackFoundry CLI can install generated module items directly, including aggregate preset blocks such as `/r/provider-adapters.json`.
42+
- The StackFoundry command can install generated module items directly, including aggregate preset blocks such as `/r/provider-adapters.json`.
4343
- `/r/presets/*.json` files are StackFoundry preset manifests for tooling and inspection. They are intentionally not shadcn registry item documents; use `/r/<preset>.json` for installable preset payloads.
4444

4545
## StackFoundry Rules

docs/repository.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ StackFoundry is a source registry. Every directory should either own product sou
77
- `apps/` contains runnable applications.
88
- `docs/` contains product and maintainer documentation.
99
- `examples/` contains install targets and walkthroughs used to prove registry modules in realistic app shapes.
10-
- `packages/` is reserved for extracted library packages when CLI, registry loading, schema validation, and shared utilities outgrow `apps/cli`.
10+
- `packages/` is reserved for extracted library packages when command behavior, registry loading, schema validation, and shared utilities outgrow `apps/cli`.
1111
- `public/r/` contains generated registry output. Do not edit it by hand.
1212
- `registry/` contains source modules and presets. This is the product surface.
13-
- `scripts/` is reserved for standalone maintenance scripts that should not live inside the CLI.
13+
- `scripts/` is reserved for standalone maintenance scripts that should not live inside the StackFoundry command.
1414

1515
## Applications
1616

@@ -42,4 +42,4 @@ Run:
4242
pnpm check
4343
```
4444

45-
This runs registry validation, CLI syntax checks, dry-run installs, real install smoke tests, registry generation, compatibility verification, and the web build.
45+
This runs registry validation, command syntax checks, dry-run installs, real install smoke tests, registry generation, compatibility verification, and the web build.

examples/next-saas/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The example is command-driven so it stays reproducible and does not duplicate a
99
```bash
1010
rm -rf /tmp/stackfoundry-next-saas
1111
mkdir -p /tmp/stackfoundry-next-saas
12-
pnpm cli add preset next-saas --target /tmp/stackfoundry-next-saas
12+
pnpm stackfoundry add preset next-saas --target /tmp/stackfoundry-next-saas
1313
```
1414

1515
## Dry Run
1616

1717
```bash
18-
pnpm cli add preset next-saas --target /tmp/stackfoundry-next-saas --dry-run
18+
pnpm stackfoundry add preset next-saas --target /tmp/stackfoundry-next-saas --dry-run
1919
```
2020

2121
## What This Proves

examples/saas-coverage/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ This example proves the broad SaaS coverage preset:
1414
```bash
1515
rm -rf /tmp/stackfoundry-saas-coverage
1616
mkdir -p /tmp/stackfoundry-saas-coverage
17-
pnpm cli add preset saas-coverage --target /tmp/stackfoundry-saas-coverage
17+
pnpm stackfoundry add preset saas-coverage --target /tmp/stackfoundry-saas-coverage
1818
```
1919

2020
## Dry Run
2121

2222
```bash
23-
pnpm cli add preset saas-coverage --target /tmp/stackfoundry-saas-coverage --dry-run
23+
pnpm stackfoundry add preset saas-coverage --target /tmp/stackfoundry-saas-coverage --dry-run
2424
```
2525

2626
## What This Proves

package.json

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,43 @@
1616
"dev": "pnpm dev:web",
1717
"build": "pnpm registry:build && pnpm build:web",
1818
"check": "pnpm check:registry && pnpm check:web",
19-
"check:registry": "pnpm registry:doctor && pnpm lint:cli && pnpm lint:packages && pnpm registry:build && pnpm registry:compat && pnpm test:brand && pnpm test:registry",
19+
"check:registry": "pnpm registry:doctor && pnpm lint:command && pnpm lint:packages && pnpm registry:build && pnpm registry:compat && pnpm test:brand && pnpm test:registry",
2020
"check:web": "pnpm lint:web && pnpm typecheck:web && pnpm build:web",
21-
"lint": "pnpm lint:cli && pnpm lint:packages && pnpm lint:web",
22-
"lint:cli": "node --check apps/cli/src/cli.mjs",
21+
"lint": "pnpm lint:command && pnpm lint:packages && pnpm lint:web",
2322
"lint:web": "biome check apps/web",
2423
"lint:web:fix": "biome check --write apps/web",
2524
"typecheck:web": "pnpm --filter @stackfoundry/web typecheck",
2625
"test": "pnpm test:registry",
2726
"test:brand": "node scripts/smoke-brand.mjs",
2827
"test:registry": "pnpm test:registry:dry && pnpm test:registry:install",
29-
"test:registry:dry": "rm -rf /tmp/stackfoundry-test && mkdir -p /tmp/stackfoundry-test && pnpm cli list >/dev/null && pnpm cli presets >/dev/null && pnpm cli add next-saas-shell --target /tmp/stackfoundry-test/next-saas-module >/dev/null && test -f /tmp/stackfoundry-test/next-saas-module/apps/web/src/components/stackfoundry/app-shell.tsx && pnpm cli add auth-core --target /tmp/stackfoundry-test/auth-core >/dev/null && test -f /tmp/stackfoundry-test/auth-core/docs/auth-architecture.md && pnpm cli add cloudflare-pages --target /tmp/stackfoundry-test/cloudflare-pages >/dev/null && test -f /tmp/stackfoundry-test/cloudflare-pages/apps/web/src/lib/stackfoundry/providers/cloudflare-pages.ts && pnpm cli add railway-deploy --target /tmp/stackfoundry-test/railway-deploy >/dev/null && test -f /tmp/stackfoundry-test/railway-deploy/apps/web/src/lib/stackfoundry/providers/railway-deploy.ts && pnpm cli add api-keys --target /tmp/stackfoundry-test >/dev/null && pnpm cli diff api-keys --target /tmp/stackfoundry-test >/dev/null && pnpm cli add preset next-saas --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm cli add preset provider-adapters --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm cli add preset saas-coverage --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm cli add public/r/api-keys.json --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm cli add public/r/provider-adapters.json --target /tmp/stackfoundry-test --dry-run >/dev/null",
30-
"test:registry:install": "rm -rf /tmp/stackfoundry-install && mkdir -p /tmp/stackfoundry-install/next-saas /tmp/stackfoundry-install/provider-adapters /tmp/stackfoundry-install/cloudflare-native /tmp/stackfoundry-install/vercel-native /tmp/stackfoundry-install/saas-coverage /tmp/stackfoundry-install/registry-api-keys /tmp/stackfoundry-install/registry-adapters /tmp/stackfoundry-install/url-api-keys /tmp/stackfoundry-install/url-adapters && pnpm cli add preset next-saas --target /tmp/stackfoundry-install/next-saas >/dev/null && pnpm cli add preset provider-adapters --target /tmp/stackfoundry-install/provider-adapters >/dev/null && pnpm cli add preset cloudflare-native --target /tmp/stackfoundry-install/cloudflare-native >/dev/null && pnpm cli add preset vercel-native --target /tmp/stackfoundry-install/vercel-native >/dev/null && pnpm cli add preset saas-coverage --target /tmp/stackfoundry-install/saas-coverage >/dev/null && pnpm cli add public/r/api-keys.json --target /tmp/stackfoundry-install/registry-api-keys >/dev/null && pnpm cli add public/r/provider-adapters.json --target /tmp/stackfoundry-install/registry-adapters >/dev/null && pnpm cli add https://stackfoundry.dev/r/api-keys.json --target /tmp/stackfoundry-install/url-api-keys >/dev/null && pnpm cli add https://stackfoundry.dev/r/provider-adapters.json --target /tmp/stackfoundry-install/url-adapters >/dev/null",
31-
"cli": "node apps/cli/src/cli.mjs",
32-
"registry:list": "pnpm cli list",
33-
"registry:categories": "pnpm cli categories",
34-
"registry:presets": "pnpm cli presets",
35-
"registry:doctor": "pnpm cli doctor",
28+
"test:registry:dry": "rm -rf /tmp/stackfoundry-test && mkdir -p /tmp/stackfoundry-test && pnpm stackfoundry list >/dev/null && pnpm stackfoundry presets >/dev/null && pnpm stackfoundry add next-saas-shell --target /tmp/stackfoundry-test/next-saas-module >/dev/null && test -f /tmp/stackfoundry-test/next-saas-module/apps/web/src/components/stackfoundry/app-shell.tsx && pnpm stackfoundry add auth-core --target /tmp/stackfoundry-test/auth-core >/dev/null && test -f /tmp/stackfoundry-test/auth-core/docs/auth-architecture.md && pnpm stackfoundry add cloudflare-pages --target /tmp/stackfoundry-test/cloudflare-pages >/dev/null && test -f /tmp/stackfoundry-test/cloudflare-pages/apps/web/src/lib/stackfoundry/providers/cloudflare-pages.ts && pnpm stackfoundry add railway-deploy --target /tmp/stackfoundry-test/railway-deploy >/dev/null && test -f /tmp/stackfoundry-test/railway-deploy/apps/web/src/lib/stackfoundry/providers/railway-deploy.ts && pnpm stackfoundry add api-keys --target /tmp/stackfoundry-test >/dev/null && pnpm stackfoundry diff api-keys --target /tmp/stackfoundry-test >/dev/null && pnpm stackfoundry add preset next-saas --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm stackfoundry add preset provider-adapters --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm stackfoundry add preset saas-coverage --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm stackfoundry add public/r/api-keys.json --target /tmp/stackfoundry-test --dry-run >/dev/null && pnpm stackfoundry add public/r/provider-adapters.json --target /tmp/stackfoundry-test --dry-run >/dev/null",
29+
"test:registry:install": "rm -rf /tmp/stackfoundry-install && mkdir -p /tmp/stackfoundry-install/next-saas /tmp/stackfoundry-install/provider-adapters /tmp/stackfoundry-install/cloudflare-native /tmp/stackfoundry-install/vercel-native /tmp/stackfoundry-install/saas-coverage /tmp/stackfoundry-install/registry-api-keys /tmp/stackfoundry-install/registry-adapters /tmp/stackfoundry-install/url-api-keys /tmp/stackfoundry-install/url-adapters && pnpm stackfoundry add preset next-saas --target /tmp/stackfoundry-install/next-saas >/dev/null && pnpm stackfoundry add preset provider-adapters --target /tmp/stackfoundry-install/provider-adapters >/dev/null && pnpm stackfoundry add preset cloudflare-native --target /tmp/stackfoundry-install/cloudflare-native >/dev/null && pnpm stackfoundry add preset vercel-native --target /tmp/stackfoundry-install/vercel-native >/dev/null && pnpm stackfoundry add preset saas-coverage --target /tmp/stackfoundry-install/saas-coverage >/dev/null && pnpm stackfoundry add public/r/api-keys.json --target /tmp/stackfoundry-install/registry-api-keys >/dev/null && pnpm stackfoundry add public/r/provider-adapters.json --target /tmp/stackfoundry-install/registry-adapters >/dev/null && pnpm stackfoundry add https://stackfoundry.dev/r/api-keys.json --target /tmp/stackfoundry-install/url-api-keys >/dev/null && pnpm stackfoundry add https://stackfoundry.dev/r/provider-adapters.json --target /tmp/stackfoundry-install/url-adapters >/dev/null",
30+
"registry:list": "pnpm stackfoundry list",
31+
"registry:categories": "pnpm stackfoundry categories",
32+
"registry:presets": "pnpm stackfoundry presets",
33+
"registry:doctor": "pnpm stackfoundry doctor",
3634
"validate": "pnpm registry:doctor",
37-
"registry:build": "pnpm cli build",
35+
"registry:build": "pnpm stackfoundry build",
3836
"registry:verify": "pnpm registry:doctor && pnpm registry:build",
39-
"registry:add:next-saas": "pnpm cli add preset next-saas",
40-
"registry:add:adapters": "pnpm cli add preset provider-adapters",
41-
"registry:dry:next-saas": "pnpm cli add preset next-saas --dry-run",
42-
"registry:dry:adapters": "pnpm cli add preset provider-adapters --dry-run",
43-
"registry:diff:api-keys": "pnpm cli diff api-keys",
37+
"registry:add:next-saas": "pnpm stackfoundry add preset next-saas",
38+
"registry:add:adapters": "pnpm stackfoundry add preset provider-adapters",
39+
"registry:dry:next-saas": "pnpm stackfoundry add preset next-saas --dry-run",
40+
"registry:dry:adapters": "pnpm stackfoundry add preset provider-adapters --dry-run",
41+
"registry:diff:api-keys": "pnpm stackfoundry diff api-keys",
4442
"dev:web": "pnpm --dir apps/web dev",
4543
"build:web": "pnpm --filter @stackfoundry/web build",
4644
"start:web": "pnpm --dir apps/web start",
4745
"clean": "rm -rf apps/web/.next apps/web/public/r public/r /tmp/stackfoundry-test /tmp/stackfoundry-install",
4846
"registry:compat": "node scripts/check-registry-compat.mjs",
49-
"registry:add:block:api-keys": "pnpm cli add https://stackfoundry.dev/r/api-keys.json",
50-
"registry:add:block:adapters": "pnpm cli add https://stackfoundry.dev/r/provider-adapters.json",
51-
"registry:dry:block:api-keys": "pnpm cli add https://stackfoundry.dev/r/api-keys.json --dry-run",
52-
"registry:dry:block:adapters": "pnpm cli add https://stackfoundry.dev/r/provider-adapters.json --dry-run",
47+
"registry:add:block:api-keys": "pnpm stackfoundry add https://stackfoundry.dev/r/api-keys.json",
48+
"registry:add:block:adapters": "pnpm stackfoundry add https://stackfoundry.dev/r/provider-adapters.json",
49+
"registry:dry:block:api-keys": "pnpm stackfoundry add https://stackfoundry.dev/r/api-keys.json --dry-run",
50+
"registry:dry:block:adapters": "pnpm stackfoundry add https://stackfoundry.dev/r/provider-adapters.json --dry-run",
5351
"lint:packages": "node --check packages/schema/src/index.mjs && node --check packages/utils/src/index.mjs && node --check packages/registry/src/index.mjs && node --check packages/generator/src/index.mjs",
54-
"registry:add:coverage": "pnpm cli add preset saas-coverage",
55-
"registry:dry:coverage": "pnpm cli add preset saas-coverage --dry-run"
52+
"registry:add:coverage": "pnpm stackfoundry add preset saas-coverage",
53+
"registry:dry:coverage": "pnpm stackfoundry add preset saas-coverage --dry-run",
54+
"stackfoundry": "node apps/cli/src/cli.mjs",
55+
"lint:command": "node --check apps/cli/src/cli.mjs"
5656
},
5757
"dependencies": {
5858
"next": "latest",
@@ -74,7 +74,7 @@
7474
"registry-blocks",
7575
"editable-source",
7676
"modules",
77-
"cli",
77+
"command",
7878
"stripe",
7979
"clerk",
8080
"vercel",

packages/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Packages
22

3-
This directory contains reusable internals for the StackFoundry CLI and registry build pipeline.
3+
This directory contains reusable internals for the StackFoundry command and registry build pipeline.
44

55
The split mirrors the shape of mature source registry CLIs: the executable stays thin, while schema rules, registry IO, generation helpers, and utilities live behind package boundaries.
66

@@ -17,4 +17,4 @@ The split mirrors the shape of mature source registry CLIs: the executable stays
1717
- Keep IO helpers in `registry`.
1818
- Keep write safety in `generator`.
1919
- Keep validation constants in `schema`.
20-
- Move CLI code into packages only when it reduces coupling or is needed by more than one caller.
20+
- Move command code into packages only when it reduces coupling or is needed by more than one caller.

0 commit comments

Comments
 (0)