|
1 | | -<img src="assets/logo.svg" alt="dev.kit logo"> |
| 1 | +<img src="assets/logo.svg" alt="dev.kit logo" width="200"> |
2 | 2 |
|
3 | | -# dev.kit |
| 3 | +# dev.kit — Resolve the Development Drift |
4 | 4 |
|
5 | | -Deterministic developer workflow kit for humans + AI. One CLI entrypoint, shared prompts/templates under `src/`, and a stable contract for iteration. |
| 5 | +**Experienced engineering flow with no-bullshit results.** |
6 | 6 |
|
7 | | -## Install |
| 7 | +`dev.kit` resolves the **Drift** (intent divergence) by **Normalizing** it into a deterministic path and **Iterating** to the result. It acts as a **Thin Empowerment Layer** (Grounding) that bridges chaotic intent with repository-based skills. |
8 | 8 |
|
9 | | -Quick start (one-liner): |
| 9 | +## How it Works: The Grounding Bridge |
10 | 10 |
|
11 | | -```bash |
12 | | -curl -fsSL https://raw.githubusercontent.com/udx/dev.kit/main/bin/scripts/install.sh | bash |
| 11 | +`dev.kit` empowers AI agents (Gemini, Antigravity) with repository-centric grounding: |
13 | 12 |
|
14 | | -# If the installer doesn't prompt for shell updates: |
15 | | -source "$HOME/.udx/dev.kit/source/env.sh" |
16 | | -``` |
| 13 | +1. **Grounding & Normalization**: Intent is mapped to repo-specific logic and normalized into a deterministic execution plan. |
| 14 | +2. **Skill Discovery**: `dev.kit` exposes "Experienced Skills" directly to your AI agent's toolbelt (native skill discovery). |
| 15 | +3. **Waterfall Progression**: AI iterates through instruction steps with deterministic validation and real-time feedback. |
17 | 16 |
|
18 | | -```mermaid |
19 | | -flowchart TD |
20 | | - A["Start"] --> B["Run installer"] |
21 | | - B --> C{"Shell update prompt?"} |
22 | | - C -->|"Yes"| D["Shell updates applied"] |
23 | | - C -->|"No"| E["Source env.sh"] |
24 | | - D --> F["Installed"] |
25 | | - E --> F |
26 | | -``` |
| 17 | + |
27 | 18 |
|
28 | | -## Configure (First Run) |
| 19 | +## Core Interface |
29 | 20 |
|
30 | | -See current config: |
| 21 | +`dev.kit` focuses on repository health and agent empowerment, leaving high-level reasoning to your preferred agent. |
31 | 22 |
|
32 | | -```bash |
33 | | -dev.kit config show |
34 | | -``` |
| 23 | +- **`dev.kit status`**: (Default) Engineering brief and system diagnostic. |
| 24 | +- **`dev.kit ai`**: Unified agent integration management (Sync, Skills, Status). |
| 25 | +- **`dev.kit task`**: Manage the lifecycle of active workflows and sessions. |
| 26 | +- **`dev.kit config`**: Environment and repository orchestration settings. |
35 | 27 |
|
36 | | -Defaults (out of the box): |
| 28 | +## Managed AI Skills |
37 | 29 |
|
38 | | -- AI disabled (`ai.enabled = false`) |
39 | | -- Minimal prompt (`exec.prompt = ai.codex.min`) |
40 | | -- Non-streaming logs (`exec.stream = false`) |
41 | | -- Repo-scoped context (`context.enabled = true`, `context.max_bytes = 4000`) |
| 30 | +`dev.kit` provides a suite of deterministic engineering skills that are grounded in your repository's truth: |
42 | 31 |
|
43 | | -Optional: set explicit state path |
| 32 | +- **`visualizer`**: Generate and export high-fidelity Mermaid diagrams (SVG). |
| 33 | +- **`git-sync`**: Resolve repository drift with logical, atomic commits. |
| 34 | +- **`core`**: Maintain environment health and synchronize agent context. |
44 | 35 |
|
45 | | -```bash |
46 | | -dev.kit config set --key state_path --value "~/.udx/dev.kit/state" |
47 | | -``` |
| 36 | +> **Execution**: Run any skill with `dev.kit skills run <name>`. |
48 | 37 |
|
49 | | -Enable AI (Codex): |
| 38 | +## AI Integration |
50 | 39 |
|
51 | | -```bash |
52 | | -dev.kit config set --key ai.enabled --value true |
53 | | -dev.kit codex apply |
54 | | -``` |
55 | | - |
56 | | -```mermaid |
57 | | -flowchart TD |
58 | | - A["Config show"] --> B{"Enable AI?"} |
59 | | - B -->|"Yes"| C["Set ai.enabled=true"] |
60 | | - C --> D["dev.kit codex apply"] |
61 | | - B -->|"No"| E["Keep AI disabled"] |
62 | | - D --> F["Configured"] |
63 | | - E --> F |
64 | | -``` |
65 | | - |
66 | | -## Use (Incremental) |
67 | | - |
68 | | -1. **Prompt-only (no AI installed)** |
69 | | - Generate a deterministic prompt and run it in any tool: |
70 | | - |
71 | | -```bash |
72 | | -dev.kit prompt --request "Summarize repo structure" |
73 | | -``` |
74 | | - |
75 | | -2. **AI-enabled (Codex installed)** |
76 | | - Run `dev.kit exec` to generate + execute the prompt: |
| 40 | +`dev.kit` integrates natively with your AI agent to enforce standardization and repository truth. |
77 | 41 |
|
78 | 42 | ```bash |
79 | | -dev.kit exec "Summarize repo structure" |
| 43 | +# Sync skills and engineering context to your agent (Gemini/Codex) |
| 44 | +dev.kit ai sync |
80 | 45 | ``` |
81 | 46 |
|
82 | | -If Codex is not installed, `dev.kit exec` prints the prompt so you can run it manually. |
83 | | - |
84 | | -3. **Dry-run (print only)** |
| 47 | +> **Grounding Layer**: `dev.kit` does not replace your agent; it hydrates it with the repository's source of truth. |
85 | 48 |
|
86 | | -```bash |
87 | | -dev.kit exec --print "Summarize repo structure" |
88 | | -``` |
89 | | - |
90 | | -```mermaid |
91 | | -flowchart TD |
92 | | - A["Pick mode"] --> B["Prompt-only: dev.kit prompt"] |
93 | | - A --> C["AI-enabled: dev.kit exec"] |
94 | | - A --> D["Dry-run: dev.kit exec --print"] |
95 | | - B --> E["Run prompt manually"] |
96 | | - C --> F["Run via Codex"] |
97 | | - D --> E |
98 | | -``` |
99 | | - |
100 | | -## Auto-Detection + Suggestions |
101 | | - |
102 | | -- `dev.kit exec` uses the same prompt generator as `dev.kit prompt`. |
103 | | -- If AI is disabled or Codex is missing, `dev.kit exec` prints the prompt and exits. |
104 | | -- Context history is automatically included (repo-scoped). |
105 | | - |
106 | | -```mermaid |
107 | | -flowchart TD |
108 | | - A["dev.kit exec"] --> B{"AI enabled?"} |
109 | | - B -->|"No"| C["Print prompt and exit"] |
110 | | - B -->|"Yes"| D{"Codex installed?"} |
111 | | - D -->|"No"| C |
112 | | - D -->|"Yes"| E["Include repo context history"] |
113 | | - E --> F["Generate prompt from templates"] |
114 | | - F --> G["Execute via Codex"] |
115 | | - G --> H["Output result"] |
116 | | -``` |
117 | | - |
118 | | -## What You Can Do (Core) |
119 | | - |
120 | | -```bash |
121 | | -dev.kit prompt --request "Summarize repo structure" |
122 | | -dev.kit exec "Summarize repo structure" |
123 | | -dev.kit exec --print "Summarize repo structure" |
124 | | -``` |
125 | | - |
126 | | -Context controls: |
127 | | - |
128 | | -```bash |
129 | | -dev.kit exec --reset "remember: 1234" |
130 | | -dev.kit exec --no-context "one-off question" |
131 | | -dev.kit context show |
132 | | -``` |
133 | | - |
134 | | -## With AI Integration (Empower) |
135 | | - |
136 | | -Apply repo skills to Codex: |
| 49 | +## Install |
137 | 50 |
|
138 | 51 | ```bash |
139 | | -dev.kit codex apply |
140 | | -dev.kit ai skills |
| 52 | +curl -fsSL https://udx.dev/dev.kit/install.sh | bash |
141 | 53 | ``` |
142 | 54 |
|
143 | | -Tips: |
144 | | - |
145 | | -- Streaming logs are off by default; pass `--stream` for full runner output. |
146 | | -- Simple requests answer directly; complex requests route to workflow. |
147 | | - |
148 | | -## Docs |
149 | | - |
150 | | -Start here: `docs/README.md` |
151 | | - |
152 | | -Doc map (by topic): |
153 | | - |
154 | | -- CLI and execution model: `docs/cli/overview.md`, `docs/cli/execution/index.md` |
155 | | -- AI integration: `docs/ai/README.md` |
156 | | -- Concepts and contracts: `docs/concepts/index.md`, `docs/concepts/specs.md` |
157 | | -- References and standards: `docs/reference/udx-reference-index.md` |
| 55 | +## Documentation |
158 | 56 |
|
159 | | -## Repo Map (Core) |
| 57 | +- **Managed AI Skills**: `docs/ai/skills.md` |
| 58 | +- **Scenarios & Workflows**: `docs/scenarios/README.md` |
| 59 | +- **CLI Overview**: `docs/cli/overview.md` |
| 60 | +- **AI Orchestration**: `docs/ai/README.md` |
160 | 61 |
|
161 | | -- `bin/` CLI entrypoints |
162 | | -- `lib/` runtime library code |
163 | | -- `src/` runtime source + templates |
164 | | -- `config/` runtime configuration |
165 | | -- `docs/` specs and contracts |
166 | | -- `src/ai/` shared AI integration assets |
167 | | -- `src/ai/data/` shared AI data (JSON) |
168 | | -- `src/ai/integrations/` integration-specific schemas/templates (codex, claude, gemini) |
169 | | -- `src/ai/data/prompts.json` iteration prompts |
170 | | -- `src/mermaid/` mermaid templates |
171 | | -- `src/docker/` docker assets |
172 | | -- `scripts/` helpers |
| 62 | +--- |
| 63 | +_UDX DevSecOps Team_ |
0 commit comments