You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,22 @@
1
1
# CaseForge Studio
2
2
3
-
CaseForge Studio turns a rough product idea into an interview-ready dossier through a deterministic multi-stage pipeline. It ships with a local web app, CLI, local HTTP API, persisted run history, and an optional OpenAI overlay that refines the final dossier without becoming the only path through the product.
3
+
CaseForge Studio turns a rough product idea into an implementation-ready project blueprint through a deterministic multi-stage pipeline. It ships with a local web app, CLI, local HTTP API, persisted run history, and an optional OpenAI overlay that refines the final blueprint without becoming the only path through the product.
4
4
5
-
The core thesis is simple: a strong portfolio project should be explainable, scoped, and reviewable. CaseForge Studio helps turn vague ideas into artifacts that are easier to demo, compare, and improve.
5
+
The core thesis is simple: a strong project idea should become explainable, scoped, reviewable, and ready for execution. CaseForge Studio helps turn vague ideas into artifacts that are easier to evaluate, compare, and improve.
6
6
7
7
## Why It Matters
8
8
9
-
- Deterministic by default, so the product is demoable without external services.
10
-
- Optional live-provider overlay for a stronger AI story when credentials are available.
9
+
- Deterministic by default, so the product remains usable without external services.
10
+
- Optional live-provider overlay for stronger AI-assisted refinement when credentials are available.
11
11
- Multiple surfaces from one shared service layer: CLI, browser UI, and HTTP API.
12
12
- Saved runs and comparison views make iteration visible instead of hand-wavy.
13
-
- Fast to explain in an interview: brief in, dossier out, compare runs, choose the strongest artifact.
13
+
- Fast to evaluate in a technical review: brief in, blueprint out, compare runs, choose the strongest implementation path.
14
14
15
15
## Feature Set
16
16
17
-
- Planner, architect, evaluator, and storyteller stages
17
+
- Planner, architect, evaluator, and delivery-path stages
18
18
- Markdown, JSON, and summary export under `outputs/` for persisted local runs
19
-
- Local web app with dossier preview, saved-run browsing, and comparison
19
+
- Local web app with blueprint preview, saved-run browsing, and comparison
20
20
- Local HTTP API for generation, preview, retrieval, and compare flows
21
21
- Optional OpenAI Responses API overlay with deterministic fallback
22
22
- Standard-library-only backend runtime
@@ -30,12 +30,12 @@ Brief
30
30
-> planner
31
31
-> architect
32
32
-> evaluator
33
-
-> storyteller
34
-
-> dossier export
33
+
-> delivery path
34
+
-> blueprint export
35
35
-> optional OpenAI public-facing overlay
36
36
```
37
37
38
-
The deterministic path is the primary product path. The live provider is an enhancement layer, not a dependency for the base demo.
38
+
The deterministic path is the primary product path. The live provider is an enhancement layer, not a dependency for the base workflow.
39
39
40
40
## Quickstart
41
41
@@ -45,16 +45,16 @@ From the `caseforge-studio` project root:
45
45
python -m pip install -e .
46
46
```
47
47
48
-
Generate a saved dossier:
48
+
Generate a saved blueprint:
49
49
50
50
```powershell
51
-
python -m caseforge create "Build an AI interview coach that turns a resume and job description into practice questions, STAR prompts, and a confidence score."
51
+
python -m caseforge create "Build an AI operations copilot that turns incident notes, service metrics, and follow-up tasks into a release-ready action plan."
52
52
```
53
53
54
-
Preview a dossier without persistence:
54
+
Preview a blueprint without persistence:
55
55
56
56
```powershell
57
-
python -m caseforge create "Build an AI interview coach." --preset ml --preview --json
57
+
python -m caseforge create "Build an AI operations copilot." --preset ml --preview --json
58
58
```
59
59
60
60
Run the local web app:
@@ -85,7 +85,7 @@ The live provider path is optional. Without credentials, the app falls back to t
85
85
```powershell
86
86
$env:OPENAI_API_KEY="your-key"
87
87
$env:OPENAI_MODEL="gpt-5-mini"
88
-
python -m caseforge create "Build an AI interview coach." --preset ml --provider openai --preview --json
88
+
python -m caseforge create "Build an AI operations copilot." --preset ml --provider openai --preview --json
89
89
```
90
90
91
91
Supported environment variables:
@@ -107,16 +107,16 @@ python -m caseforge create "Design an operations copilot that summarizes inciden
107
107
Create from a file:
108
108
109
109
```powershell
110
-
python -m caseforge create --brief-file examples/briefs/ai-interview-coach.md --goal "Show AI judgment"
"brief": "Build an AI interview coach that turns a resume and job description into mock questions and rehearsal plans.",
140
-
"audience": "Hiring manager",
139
+
"brief": "Build an AI operations copilot that turns incident notes, service metrics, and follow-up tasks into a release-ready action plan.",
140
+
"audience": "Technical stakeholders",
141
141
"mode": "AI assistant",
142
-
"goal": "Show AI judgment",
142
+
"goal": "Emphasize AI decisioning",
143
143
"preset": "ml",
144
144
"provider": "openai",
145
145
"provider_model": "gpt-5-mini"
146
146
}
147
147
```
148
148
149
-
## Demo Flow
149
+
## Usage Flow
150
150
151
151
1. Start the web app and paste a rough project idea into the brief box.
152
-
2. Generate a dossier and show the score, architecture section, and interview story.
153
-
3. Open the committed sample dossier at `examples/sample-dossier.md` or a locally generated artifact under `outputs/<slug>/dossier.md`.
154
-
4. Compare two runs to show score movement, provider path, and recommendation changes.
152
+
2. Generate a blueprint and review the score, architecture section, and delivery path.
153
+
3. Open the committed sample blueprint at `examples/sample-blueprint.md` or a locally generated artifact under `outputs/<slug>/dossier.md`.
154
+
4. Compare two runs to review score movement, provider path, and recommendation changes.
155
155
5. Explain why the deterministic path is the default and when the live provider is worth using.
156
156
6. Close with the test suite and release checklist.
157
157
@@ -161,8 +161,8 @@ Example request:
161
161
-`python -m build`
162
162
- smoke-test `GET /health`
163
163
- smoke-test `GET /`
164
-
- generate one dossier through the CLI
165
-
- generate one dossier through the web UI
164
+
- generate one blueprint through the CLI
165
+
- generate one blueprint through the web UI
166
166
167
167
## Project Layout
168
168
@@ -171,15 +171,15 @@ caseforge-studio/
171
171
|-- .github/
172
172
|-- caseforge/
173
173
|-- examples/
174
-
| |-- sample-dossier.md
174
+
| |-- sample-blueprint.md
175
175
| `-- briefs/
176
176
|-- tests/
177
177
|-- CHANGELOG.md
178
178
|-- RELEASE_CHECKLIST.md
179
179
`-- README.md
180
180
```
181
181
182
-
`outputs/` is generated locally at runtime and is intentionally kept out of version control. The committed public sample dossier lives at `examples/sample-dossier.md`.
182
+
`outputs/` is generated locally at runtime and is intentionally kept out of version control. The committed public sample blueprint lives at `examples/sample-blueprint.md`.
183
183
184
184
## Release And Security
185
185
@@ -192,12 +192,12 @@ caseforge-studio/
192
192
193
193
- The server is local-first and single-tenant.
194
194
- There is no built-in authentication or multi-user access control.
195
-
- The OpenAI overlay path should be demonstrated only with deliberate credential handling.
195
+
- The OpenAI overlay path should be used only with deliberate credential handling.
196
196
- The default runtime is still a local stdlib HTTP server, not a multi-tenant hosted deployment stack.
197
197
198
198
## Next Steps
199
199
200
200
- Add a clean deployment wrapper around the local server path
201
-
- Capture one intentional live-provider demo artifact
201
+
- Capture one intentional live-provider blueprint artifact
202
202
- Add stronger browser-level regression coverage
203
-
- Promote the best saved dossier flow into a tighter public release
203
+
- Promote the best saved blueprint flow into a tighter public release
Copy file name to clipboardExpand all lines: SECURITY.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Scope
4
4
5
-
CaseForge Studio is currently a local-first, single-tenant application. It is designed for workstation demos, product iteration, and portfolio presentation, not for untrusted multi-tenant deployment in its current form.
5
+
CaseForge Studio is currently a local-first, single-tenant application. It is designed for local validation, product iteration, and technical review, not for untrusted multi-tenant deployment in its current form.
6
6
7
7
## Supported Surface
8
8
@@ -13,8 +13,8 @@ CaseForge Studio is currently a local-first, single-tenant application. It is de
13
13
## Security Expectations
14
14
15
15
- Do not commit API keys, tokens, or `.env` files.
16
-
- Treat persisted dossier content as local project data unless you intentionally sanitize it for sharing.
17
-
- Use the deterministic provider path by default when recording demos or testing on untrusted environments.
16
+
- Treat persisted blueprint content as local project data unless you intentionally sanitize it for sharing.
17
+
- Use the deterministic provider path by default when capturing walkthroughs or testing on untrusted environments.
18
18
- Do not expose the local server directly to the public internet without adding authentication, reverse-proxy controls, and deployment hardening.
0 commit comments