mycontext-cli 4.2.14 β 4.2.15
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/README.md +60 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,66 +9,85 @@ MyContext is not an AI code generatorβit's a natural-language-to-project compi
|
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## π§ Core Philosophy
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
### Zero-Hallucination Compilation
|
|
15
|
+
Most AI tools act as "chat-driven coders" that guess your requirements. MyContext acts as a **Natural Language Compiler**:
|
|
16
|
+
1. **Analyze**: LLM parses your intent into a strict JSON manifest (FSR).
|
|
17
|
+
2. **Clarify**: The CLI identifies gaps and prompts you *before* any code is written.
|
|
18
|
+
3. **Generate**: Deterministic script templates render valid, typed Next.js code.
|
|
15
19
|
|
|
16
|
-
###
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
20
|
+
### The Living Brain (`.mycontext/`)
|
|
21
|
+
Every project is governed by a local "brain" folder that ensures your code, types, and design tokens never drift:
|
|
22
|
+
- `context.json`: The master source of truth for your project features.
|
|
23
|
+
- `design_manifest.json`: Your premium design tokens and layout rules.
|
|
24
|
+
- `registry/`: Automated tracking of all generated components and actions.
|
|
21
25
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## π NEW: Phase 0.7 Premium Features (VERIFIED β)
|
|
29
|
+
|
|
30
|
+
- **Smart Layout Engine**: Autonomic 8/12 grid placement based on component `weight`.
|
|
31
|
+
- **Test-Mode Fast-Forward**: Detects `__MYCONTEXT_TEST_MODE__` to speed up animations 60x.
|
|
32
|
+
- **Auto-Test Generation**: `mycontext test:generate` creates Playwright specs from your FSR.
|
|
33
|
+
- **Density Guardrails**: Visual checks to prevent "rammed UI" and visual clutter.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## ποΈ Full Project Workflow
|
|
26
38
|
|
|
27
|
-
###
|
|
28
|
-
|
|
39
|
+
### 1. Initialization (`mycontext init`)
|
|
40
|
+
Set up your framework (InstantDB, Next.js, or shadcn) and establish the project brain.
|
|
29
41
|
```bash
|
|
30
|
-
mycontext
|
|
42
|
+
mycontext init --interactive
|
|
31
43
|
```
|
|
32
|
-
-
|
|
44
|
+
*AI auto-infers 90% of your spec, reducing setup from 15 mins to 2 mins.*
|
|
33
45
|
|
|
34
|
-
###
|
|
35
|
-
|
|
46
|
+
### 2. Feature Planning (`mycontext plan`)
|
|
47
|
+
Translate a feature request into a strict FSR (Feature Structured Representation).
|
|
36
48
|
```bash
|
|
37
|
-
mycontext
|
|
49
|
+
mycontext plan "A gallery for removed background images with token display"
|
|
38
50
|
```
|
|
39
|
-
- Automatically flags nested card patterns and visual clutter to maintain a premium aesthetic score.
|
|
40
|
-
|
|
41
|
-
---
|
|
42
51
|
|
|
43
|
-
|
|
52
|
+
### 3. Deterministic Build (`mycontext build`)
|
|
53
|
+
Compile your FSR into production-ready code.
|
|
54
|
+
```bash
|
|
55
|
+
mycontext build --feature gallery
|
|
56
|
+
```
|
|
44
57
|
|
|
45
|
-
###
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
58
|
+
### 4. Continuous Sync (`mycontext sync`)
|
|
59
|
+
Automatically update your documentation and `context.json` brain as your code evolves.
|
|
60
|
+
```bash
|
|
61
|
+
mycontext sync --readme
|
|
62
|
+
```
|
|
49
63
|
|
|
50
|
-
###
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
64
|
+
### 5. Diagnostics (`mycontext doctor`)
|
|
65
|
+
Verify type safety, catch schema drift, and check for "as any" usage.
|
|
66
|
+
```bash
|
|
67
|
+
mycontext doctor --verbose
|
|
68
|
+
```
|
|
55
69
|
|
|
56
70
|
---
|
|
57
71
|
|
|
58
|
-
## π¦
|
|
59
|
-
|
|
60
|
-
### Installation
|
|
72
|
+
## π¦ Installation
|
|
61
73
|
```bash
|
|
62
|
-
# Install globally
|
|
63
74
|
npm install -g mycontext-cli
|
|
64
75
|
```
|
|
65
76
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## π£οΈ Roadmap
|
|
80
|
+
- [x] **Phase 0.6**: Deterministic Scaffolding & Token Tracking
|
|
81
|
+
- [x] **Phase 0.7**: Premium Layout Engine & Test-Mode
|
|
82
|
+
- [ ] **Phase 1**: Global Registry & Multi-Agent Orchestration
|
|
83
|
+
- [ ] **Phase 2**: Granular component-level targeted LLM refactors
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## π License & Links
|
|
88
|
+
MIT Β© [MyContext Team](https://github.com/farajabien/mycontext-cli)
|
|
89
|
+
- [Documentation](https://mycontext.framer.website)
|
|
90
|
+
- [NPM: mycontext-cli](https://www.npmjs.com/package/mycontext-cli)
|
|
72
91
|
|
|
73
92
|
---
|
|
74
93
|
|
package/package.json
CHANGED