@urielsh/prodify 0.1.0 → 0.1.1

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.
Files changed (3) hide show
  1. package/README.md +101 -63
  2. package/package.json +1 -1
  3. package/urielsh-prodify-0.1.0.tgz +0 -0
package/README.md CHANGED
@@ -1,92 +1,124 @@
1
1
  # Prodify
2
2
 
3
- Prodify turns AI- or vibe-coded repositories into production-grade code through a deterministic, agent-native workflow.
3
+ Prodify turns AI- and vibe-coded repositories into production-grade repositories through a deterministic, agent-native workflow.
4
4
 
5
- ## Product Purpose
5
+ It gives a repo a repeatable upgrade path instead of relying on ad hoc prompting, one-off cleanup passes, or agent memory. The CLI bootstraps the runtime. The coding agent executes the staged transformation flow inside the repo.
6
6
 
7
- Fast AI-generated code drifts into inconsistent structure, weak validation, and unclear ownership. Prodify gives that repo a repeatable upgrade path instead of relying on ad hoc prompting.
7
+ ## Why Prodify
8
8
 
9
- ## Architecture
9
+ - Turn messy AI-generated repos into structured, reviewable systems.
10
+ - Keep runtime state, tasks, artifacts, contracts, and metrics inside `.prodify/`.
11
+ - Separate repository setup from in-agent execution.
12
+ - Validate stage outputs against compiled contracts instead of trusting freeform agent claims.
10
13
 
11
- Prodify has two layers:
14
+ ## Quick Start
12
15
 
13
- - external CLI for repository setup and health
14
- - inside-agent runtime commands for actually running the contract-driven transformation flow
16
+ Install Prodify from npm:
15
17
 
16
- External CLI:
17
-
18
- - `prodify init`
19
- - `prodify status`
20
- - `prodify doctor`
21
- - `prodify update`
18
+ ```sh
19
+ npm install -g @urielsh/prodify
20
+ ```
22
21
 
23
- Inside the agent:
22
+ Prepare your coding agent once per machine:
24
23
 
25
- - read `.prodify/AGENTS.md`
26
- - `$prodify-init`
27
- - `$prodify-execute`
28
- - `$prodify-execute --auto`
29
- - `$prodify-resume`
24
+ ```sh
25
+ prodify setup-agent codex
26
+ ```
30
27
 
31
- ## Repo Model
28
+ Initialize a target repository:
32
29
 
33
- - `.prodify/` is the only required product-owned footprint.
34
- - No root-level agent files are required in the default flow.
35
- - If this repository contains a root `AGENTS.md`, treat it as repository-local contributor guidance for developing Prodify itself, not as a generated or required product runtime file.
36
- - All durable workflow state lives in `.prodify/`.
37
- - Humans edit stage contracts under `.prodify/contracts-src/`.
38
- - Runtime execution reads only compiled contracts under `.prodify/contracts/`.
39
- - Product-owned skill definitions live under `.prodify/skills/`.
40
- - Stage outputs live under `.prodify/artifacts/`.
41
- - Local baseline/final/delta scoring lives under `.prodify/metrics/`.
42
- - This repository’s checked-in repo-root `.prodify/` directory is the self-hosting workspace for Prodify itself. It includes the generated runtime layout plus repo-specific design and development artifacts, so it is not a byte-for-byte snapshot of fresh `prodify init` output.
30
+ ```sh
31
+ cd path/to/your-repo
32
+ prodify init
33
+ ```
43
34
 
44
- ## User Flow
35
+ Then open your coding agent and start the runtime:
45
36
 
46
- 1. Set up an agent once per machine:
37
+ ```text
38
+ Read .prodify/AGENTS.md and bootstrap Prodify for this repository.
39
+ ```
47
40
 
48
- ```sh
49
- prodify setup-agent codex
41
+ ```text
42
+ $prodify-init
43
+ $prodify-execute
50
44
  ```
51
45
 
52
- 2. Initialize the repository:
46
+ Use `$prodify-execute --auto` to continue without pausing between stages, or `$prodify-resume` to continue an interrupted run.
53
47
 
54
- ```sh
55
- npm run build
56
- node ./dist/index.js init
57
- ```
48
+ ## Using Prodify In Your Repo
58
49
 
59
- 3. Open the supported agent you want to use.
50
+ 1. Install the npm package.
51
+ 2. Run `prodify setup-agent <agent>` once per machine for the agent you use.
52
+ 3. Run `prodify init` inside the repository you want to upgrade.
53
+ 4. Open that repository in a supported coding agent.
54
+ 5. Tell the agent to read `.prodify/AGENTS.md`.
55
+ 6. Run `$prodify-init`, then continue with `$prodify-execute` or `$prodify-execute --auto`.
60
56
 
61
- - Codex
62
- - Claude
63
- - Copilot
64
- - OpenCode
57
+ Prodify keeps repository initialization agent-agnostic. The active runtime is resolved when `$prodify-init` runs inside the opened agent, not when `prodify init` creates `.prodify/`.
65
58
 
66
- 4. Tell it: `Read .prodify/AGENTS.md and bootstrap Prodify for this repository.`
59
+ ## How It Works
67
60
 
68
- 5. Inside that agent, run `$prodify-init`.
61
+ - `prodify init` creates the `.prodify/` runtime workspace in the repo.
62
+ - The agent reads `.prodify/AGENTS.md` as the runtime entrypoint.
63
+ - `$prodify-init` prepares the in-agent run state.
64
+ - `$prodify-execute` runs one stage at a time.
65
+ - `$prodify-execute --auto` keeps advancing until a hard stop.
66
+ - `$prodify-resume` continues from the saved runtime state.
69
67
 
70
- 6. Run `$prodify-execute` for stage-by-stage execution, or `$prodify-execute --auto` to continue until a hard stop.
68
+ Stage order:
71
69
 
72
- 7. If the flow pauses for validation or is interrupted, continue with `$prodify-resume`.
73
- 8. Use `prodify status`, `prodify doctor`, and `prodify update` from the CLI to inspect or refresh the `.prodify/` scaffolding, compiled contracts, and local metrics workspace.
70
+ - `understand`
71
+ - `diagnose`
72
+ - `architecture`
73
+ - `plan`
74
+ - `refactor`
75
+ - `validate`
74
76
 
75
- Repo initialization stays agent-agnostic. The active agent is resolved when `$prodify-init` runs inside the opened agent, not when `prodify init` creates `.prodify/`.
77
+ ## CLI Commands
78
+
79
+ - `prodify setup-agent <codex|claude|copilot|opencode>`
80
+ One-time machine setup for the coding agent runtime.
81
+ - `prodify init`
82
+ Create the `.prodify/` workspace in a repository.
83
+ - `prodify status`
84
+ Inspect runtime state and recommended next actions.
85
+ - `prodify doctor`
86
+ Check runtime health, generated files, and execution readiness.
87
+ - `prodify update`
88
+ Refresh the local Prodify workspace, compiled contracts, and related runtime assets.
89
+
90
+ ## Agent Runtime Commands
91
+
92
+ - `$prodify-init`
93
+ Bootstrap Prodify inside the opened coding agent.
94
+ - `$prodify-execute`
95
+ Run the next workflow stage interactively.
96
+ - `$prodify-execute --auto`
97
+ Continue across stages until a hard stop or policy gate.
98
+ - `$prodify-resume`
99
+ Continue from the saved `.prodify/state.json` runtime state.
100
+
101
+ ## Repo Model
102
+
103
+ - `.prodify/` is the only required product-owned footprint.
104
+ - Durable workflow state lives in `.prodify/state.json`.
105
+ - Tasks live under `.prodify/tasks/`.
106
+ - Stage outputs live under `.prodify/artifacts/`.
107
+ - Skill definitions live under `.prodify/skills/`.
108
+ - Local baseline, final, and delta scoring artifacts live under `.prodify/metrics/`.
109
+ - Fresh product users do not need root-level agent files.
76
110
 
77
111
  ## Contracts And Validation
78
112
 
79
- - Contract source files are Markdown with YAML frontmatter under `.prodify/contracts-src/`.
80
- - `prodify init` and `prodify update` compile those sources into deterministic runtime JSON under `.prodify/contracts/`.
81
- - Each stage can also declare bounded `skill_routing` metadata, while concrete skill definitions stay versioned under `.prodify/skills/`.
82
- - Status can report which stage skills were considered and activated from repository context, but contracts and validators remain authoritative.
83
- - Stage completion is gated by compiled-contract validation, not by agent assertion alone.
113
+ - Humans edit contract sources under `.prodify/contracts-src/`.
114
+ - Runtime execution reads only compiled contracts under `.prodify/contracts/`.
115
+ - Stage completion is gated by compiled-contract validation.
84
116
  - Validation checks required artifacts, write boundaries, forbidden writes, Markdown sections, JSON keys, and contract criteria.
85
117
 
86
118
  ## Local Scoring
87
119
 
88
- - Prodify can persist local baseline, final, and delta score artifacts under `.prodify/metrics/`.
89
- - Raw tool outputs and normalized scores are stored separately so the score is traceable and deterministic.
120
+ - Prodify can persist baseline, final, and delta score artifacts under `.prodify/metrics/`.
121
+ - Raw outputs and normalized scores are stored separately so scoring stays traceable and deterministic.
90
122
 
91
123
  ## Supported Agents
92
124
 
@@ -95,24 +127,30 @@ Repo initialization stays agent-agnostic. The active agent is resolved when `$pr
95
127
  - Copilot
96
128
  - OpenCode
97
129
 
98
- All supported agents use the same `.prodify/AGENTS.md` bootstrap path in the current product model.
130
+ All supported agents share the same bootstrap path: read `.prodify/AGENTS.md`, then run `$prodify-init`.
131
+
132
+ ## Development / Contributing
133
+
134
+ Prodify users and Prodify contributors follow different entrypoints:
99
135
 
100
- ## Development
136
+ - Product users start from `.prodify/AGENTS.md` inside the repository they want to improve.
137
+ - Contributors working on the Prodify source repository follow the root [AGENTS.md](/Users/urielsh/projects/prodify/AGENTS.md).
101
138
 
102
- Run the test suite:
139
+ For this self-hosting repository, the checked-in repo-root `.prodify/` directory is a development workspace for Prodify itself, not a byte-for-byte snapshot of fresh `prodify init` output.
140
+
141
+ Run the source-repo test suite with:
103
142
 
104
143
  ```sh
105
144
  npm test
106
145
  ```
107
146
 
108
- The implementation lives primarily in:
147
+ The main implementation lives in:
148
+
109
149
  - `src/`
110
150
  - `assets/presets/default/`
111
151
  - `tests/`
112
152
  - `docs/`
113
153
 
114
- Repository-local contributor guidance for this self-hosted repo lives in root [AGENTS.md](/Users/urielsh/projects/prodify/AGENTS.md). Product runtime guidance lives in [.prodify/AGENTS.md](/Users/urielsh/projects/prodify/.prodify/AGENTS.md).
115
-
116
154
  ## License
117
155
 
118
156
  This project is licensed under the Apache License 2.0. See [LICENSE](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@urielsh/prodify",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "license": "Apache-2.0",
5
5
  "private": false,
6
6
  "type": "module",
package/urielsh-prodify-0.1.0.tgz DELETED
Binary file