kaide 1.0.0 → 1.0.2
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 +67 -0
- package/package.json +29 -2
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Kaide
|
|
2
|
+
|
|
3
|
+
**AI-native** architecture kit for modern React. High-discipline protocols for autonomous agents.
|
|
4
|
+
|
|
5
|
+
> **Kaide** (Etymology: Turkish): A fundamental rule, principle, or base that provides structural integrity. The name cleverly embeds **AI** (K**ai**de), reflecting its core mission.
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
### Installation & Setup
|
|
10
|
+
|
|
11
|
+
1. Run the CLI to automatically install the configuration files:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx kaide
|
|
15
|
+
```
|
|
16
|
+
2. (Recommended) For maximum adherence, point your AI tool to your identity in **Settings/Project Rules**:
|
|
17
|
+
|
|
18
|
+
> **Adhere to `AGENTS.md` for persona/planning and `docs/` for architectural constitutions.**
|
|
19
|
+
|
|
20
|
+
### Usage Workflow
|
|
21
|
+
This kit follows a **Plan-First Protocol**:
|
|
22
|
+
- **Initialize:** Ask the AI to read the rules: `Read all .mdc files and AGENTS.md.`
|
|
23
|
+
- **Plan:** Propose a feature: `I want to build a [Feature Name]. Create an architectural plan.`
|
|
24
|
+
- **Execute:** After approving the plan, the AI will generate code following the strict constraints of the relevant `.mdc` files.
|
|
25
|
+
|
|
26
|
+
## The Problem We Solve
|
|
27
|
+
|
|
28
|
+
**Kaide** provides the missing governance layer to turn AI from a simple coder into a high-level Staff Engineer.
|
|
29
|
+
|
|
30
|
+
Without a structured architectural constitution, AI agents often suffer from:
|
|
31
|
+
- **Hallucinations & Drift:** Generating outdated patterns or mixing incompatible framework logics.
|
|
32
|
+
- **Context Bloat:** Wasting tokens and losing focus by re-learning project rules in every session.
|
|
33
|
+
- **Architectural Erosion:** Degrading code quality over time due to a lack of enforced modularity.
|
|
34
|
+
- **Inefficient Execution:** Writing boilerplate-heavy code instead of precise, feature-driven logic.
|
|
35
|
+
|
|
36
|
+
## Core Architecture
|
|
37
|
+
The system operates on a **Three-Layer Governance** model:
|
|
38
|
+
|
|
39
|
+
- **Global Constitution (`core-principles.mdc`):** Universal rules for code integrity, naming, and error management.
|
|
40
|
+
- **Framework Adapters (`nextjs.mdc`, `tanstack-start.mdc`):** Optimized protocols for Next.js 16 and TanStack Start, ensuring the AI utilizes the best patterns for each.
|
|
41
|
+
- **Technical Standards (`api.mdc`, `forms.mdc`, `testing.mdc`, etc.):** Domain-specific constraints for state, validation, and performance.
|
|
42
|
+
|
|
43
|
+
## Key Features
|
|
44
|
+
- **Elite AI Persona:** Integrated `AGENTS.md` to transform your LLM into a specialized Staff Architect.
|
|
45
|
+
- **Feature-Driven Design:** Everything is organized by domain in `src/features/`.
|
|
46
|
+
- **Zod-First Type Safety:** End-to-end type safety derived from schemas.
|
|
47
|
+
- **Optimized for Modern Tech:** Seamless support for Next.js and TanStack Start for world-class web applications.
|
|
48
|
+
- **Performance-First:** Built-in rules for LCP optimization, CLS prevention, and maximum efficiency.
|
|
49
|
+
|
|
50
|
+
## LLM Agnostic Usage
|
|
51
|
+
While optimized for Cursor (`.mdc`), **Kaide** is built on pure Markdown and works with any "Agentic" AI (Claude Code, Windsurf, GitHub Copilot CLI, etc.):
|
|
52
|
+
- All `.mdc` files are standard Markdown. No conversion is needed.
|
|
53
|
+
- **Tip:** Simply tell your agent: *"Read all rules in `.cursor/rules/` and follow the `AGENTS.md` persona"* at the start of your session.
|
|
54
|
+
|
|
55
|
+
## Technical Standards
|
|
56
|
+
| Layer | Tech Stack | Tooling |
|
|
57
|
+
| :--- | :--- | :--- |
|
|
58
|
+
| **Server State** | TanStack Query | `tanstack-query.mdc` |
|
|
59
|
+
| **Client State** | Zustand | `state-management.mdc` |
|
|
60
|
+
| **Validation** | Zod | `typescript.mdc` |
|
|
61
|
+
| **Testing** | Vitest + RTL | `testing.mdc` |
|
|
62
|
+
| **Styling** | Tailwind CSS | `ui-components.mdc` |
|
|
63
|
+
|
|
64
|
+
## Security & Performance
|
|
65
|
+
- **Zero Inline Script:** Strictly enforced CSP compliance.
|
|
66
|
+
- **Locked Boundaries:** Server-only logic is isolated from client bundles.
|
|
67
|
+
- **Optimized Assets:** Automatic enforcement of modern formats and performance patterns for peak scores.
|
package/package.json
CHANGED
|
@@ -1,8 +1,35 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kaide",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "AI-native architecture kit for modern React. High-discipline protocols for autonomous agents.",
|
|
4
5
|
"type": "module",
|
|
5
6
|
"bin": {
|
|
6
7
|
"kaide": "./bin/kaide.js"
|
|
7
|
-
}
|
|
8
|
+
},
|
|
9
|
+
"keywords": [
|
|
10
|
+
"ai",
|
|
11
|
+
"react",
|
|
12
|
+
"architecture",
|
|
13
|
+
"agent",
|
|
14
|
+
"cursor",
|
|
15
|
+
"claude",
|
|
16
|
+
"windsurf",
|
|
17
|
+
"github copilot",
|
|
18
|
+
"nextjs",
|
|
19
|
+
"tanstack",
|
|
20
|
+
"typescript",
|
|
21
|
+
"zod",
|
|
22
|
+
"cli",
|
|
23
|
+
"kaide"
|
|
24
|
+
],
|
|
25
|
+
"author": "Ömer Gülçiçek (https://github.com/omergulcicek)",
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"repository": {
|
|
28
|
+
"type": "git",
|
|
29
|
+
"url": "git+https://github.com/omergulcicek/kaide.git"
|
|
30
|
+
},
|
|
31
|
+
"bugs": {
|
|
32
|
+
"url": "https://github.com/omergulcicek/kaide/issues"
|
|
33
|
+
},
|
|
34
|
+
"homepage": "https://github.com/omergulcicek/kaide#readme"
|
|
8
35
|
}
|