@thebackstoryis/engineering-with-ai 0.3.4-beta.6 → 0.3.4
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/Docs/README.md +1 -1
- package/Docs/releases/0.3.4.md +7 -0
- package/README.md +31 -66
- package/package.json +1 -1
package/Docs/README.md
CHANGED
|
@@ -8,7 +8,7 @@ For feature delivery, **`ewai-deliver` coordinates the full fourteen-stage workf
|
|
|
8
8
|
|
|
9
9
|
If you want EWAI to act on an approved, exact pool of registered intents, read [governed autonomous intent delivery](autonomous-intent-delivery.md). It starts off, needs a named and bounded grant, and leaves human Build approval and Manual QA separate.
|
|
10
10
|
|
|
11
|
-
Read
|
|
11
|
+
Read [what's new in version 0.3.4](releases/0.3.4.md), or the [earlier Jev and OpenAI Decisions beta notes](releases/0.3.4-beta.6.md).
|
|
12
12
|
|
|
13
13
|
## New to EWAI?
|
|
14
14
|
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# What's new in this version
|
|
2
|
+
|
|
3
|
+
Version `0.3.4` adds optional **Jev and OpenAI Decisions** support to rank choices, compare AI recommendations, prioritise context and suggest personas or additional checks. Both start switched off. Configure them privately through the CLI or dashboard, compare advice in shadow mode or apply supported recommendations in active mode, and track usage, estimated cost and call limits.
|
|
4
|
+
|
|
5
|
+
**Concise answers and Grok Build.** EWAI puts the result or recommendation first, with clearer choices and less repetition. Grok Build is available as a coding companion, with dashboard and CLI controls for choosing your primary assistant and independent reviewers.
|
|
6
|
+
|
|
7
|
+
**Pick up the next ready piece of work.** Approve a list of work items and EWAI can select the next ready item using your recorded priorities. Set time and attempt limits, follow progress, and pause or recover a run. Build approval, required reviews, Manual QA and release decisions stay with you.
|
package/README.md
CHANGED
|
@@ -1,33 +1,18 @@
|
|
|
1
1
|
# Engineering With AI
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
**EWAI now supports Jev and the OpenAI Decisions API.**
|
|
6
|
-
|
|
7
|
-
- **Rank options and recommend a choice.** Evaluate available approaches and return an ordered list with a recommended answer.
|
|
8
|
-
- **Check AI recommendations.** Compare supported options returned by a larger language model with a second recommendation.
|
|
9
|
-
- **Recommend suitable personas.** Select from personas available to your project, including core, project, personal and installed premium personas.
|
|
10
|
-
- **Reduce larger-model calls.** Evaluate supported choices through focused decision calls instead of sending the same options to a larger language model.
|
|
11
|
-
- **Prioritise context.** Help order supporting context for coding and review tasks.
|
|
12
|
-
- **Support additional checks.** Assess supplied claim evidence, classify sanitised failures and recommend supplementary impact reviews and tests.
|
|
13
|
-
- **Choose your provider.** Select Jev, OpenAI Decisions or Automatic. Automatic prefers configured and authorised OpenAI access, then Jev.
|
|
14
|
-
- **Configure through the CLI or dashboard.** Save API keys privately, enable either integration and select the uses you want.
|
|
15
|
-
- **Choose shadow or active mode.** Shadow shows recommendations for comparison. Active can apply supported recommendations to context ordering and persona selection.
|
|
16
|
-
- **Track usage and estimated cost.** View decision-call usage and set call and input-token limits.
|
|
3
|
+
Engineering With AI (EWAI) helps you plan, build and review software with an AI assistant. It gives the assistant a shared record of the project, a delivery workflow and checks against your engineering standards. You keep control of the decisions and approve implementation before it starts.
|
|
17
4
|
|
|
18
|
-
|
|
5
|
+
[](https://www.conversationalcoding.dev/engineering-with-ai-harness/?utm_source=readme&utm_medium=referral&utm_campaign=ewai)
|
|
19
6
|
|
|
20
|
-
|
|
7
|
+
**Website, guides and books:** [conversationalcoding.dev](https://www.conversationalcoding.dev/engineering-with-ai-harness/?utm_source=readme&utm_medium=referral&utm_campaign=ewai) · [Online documentation](https://www.conversationalcoding.dev/engineering-with-ai-harness/docs/?utm_source=readme&utm_medium=referral&utm_campaign=ewai) · [Persona library](https://www.conversationalcoding.dev/personas/?utm_source=readme&utm_medium=referral&utm_campaign=ewai)
|
|
21
8
|
|
|
22
|
-
|
|
23
|
-
npm install --save-dev @thebackstoryis/engineering-with-ai@beta
|
|
24
|
-
```
|
|
9
|
+
## What's new in this version
|
|
25
10
|
|
|
26
|
-
|
|
11
|
+
Version `0.3.4` adds optional **Jev and OpenAI Decisions** support to rank choices, compare AI recommendations, prioritise context and suggest personas or additional checks. Both start switched off. Configure them privately through the CLI or dashboard, compare advice in shadow mode or apply supported recommendations in active mode, and track usage, estimated cost and call limits.
|
|
27
12
|
|
|
28
|
-
|
|
13
|
+
**Concise answers and Grok Build.** EWAI puts the result or recommendation first, with clearer choices and less repetition. Grok Build is available as a coding companion, with dashboard and CLI controls for choosing your primary assistant and independent reviewers.
|
|
29
14
|
|
|
30
|
-
**
|
|
15
|
+
**Pick up the next ready piece of work.** Approve a list of work items and EWAI can select the next ready item using your recorded priorities. Set time and attempt limits, follow progress, and pause or recover a run. Build approval, required reviews, Manual QA and release decisions stay with you.
|
|
31
16
|
|
|
32
17
|
## Quick start
|
|
33
18
|
|
|
@@ -41,27 +26,7 @@ ewai
|
|
|
41
26
|
|
|
42
27
|
`ewai` opens your assistant and walks you through setting up the project. See [Install and start](#install-and-start) for details.
|
|
43
28
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
## New in 0.3.1: concise answers and Grok Build
|
|
47
|
-
|
|
48
|
-
Version `0.3.1` makes EWAI's guidance more concise and adds Grok Build as a coding provider.
|
|
49
|
-
|
|
50
|
-
**Concise answers and guided decisions.** EWAI's managed instructions now prioritise correctness and usefulness, then brevity. Expect the result or recommendation first, with less repetition and routine narration. Decision requests explain the action, options and consequences, then give a recommendation with its reason and a suggested response when useful. When a request is unclear, EWAI leads with its recommended interpretation and states the assumptions that matter. The guidance is designed to cut unnecessary output; tool-result compaction is still planned, and token or cost savings haven't been measured yet. See [concise answers and guided decisions](Docs/context-management-and-token-efficiency.md#concise-answers-and-guided-decisions).
|
|
51
|
-
|
|
52
|
-
**Grok Build and coding provider settings.** EWAI can open Grok Build as a native companion, install its skills and set up project MCP. **Configuration → Coding providers** in the dashboard, or `ewai providers` in a terminal, lets you choose a primary coding CLI, independent reviewers and an eligible pool for unattended work. Each CLI keeps its own model choice by default. Grok can run isolated coding, read-only review and restricted proposal workers. Each mode passes an offline conformance check before dispatch, and your xAI key is saved privately outside the project. Build approval, required review and Manual QA stay with you. See [provider settings](Docs/reference/cli-and-configuration.md#coding-provider-settings) and [Grok Build setup](Docs/operations/installation-updating-and-entitlements.md#grok-build).
|
|
53
|
-
|
|
54
|
-
After updating, initialisation or the next check-in refreshes EWAI's managed instructions in `AGENTS.md` and `CLAUDE.md`, preserving project-authored guidance outside that block. Start a fresh host conversation after the refresh.
|
|
55
|
-
|
|
56
|
-
## EWAI can now pick up the next ready piece of work
|
|
57
|
-
|
|
58
|
-
If you’ve prepared several work items, you can choose which ones EWAI is allowed to take on. EWAI checks what’s ready, uses the priorities you’ve recorded to pick the next item, and starts its delivery workflow. Once you’ve separately approved the Build, it can run the approved build tasks, their tests and a fresh review.
|
|
59
|
-
|
|
60
|
-
This `0.3.0` release brings the capability out of beta. It adds dashboard and command-line controls to preview the work, approve the exact list, set time and attempt limits, follow progress, and pause, cancel or recover a run. New work isn’t added to the list automatically. EWAI stops when it needs a decision from you.
|
|
61
|
-
|
|
62
|
-
The final whole-delivery test stage, Manual QA and release preparation still happen through the normal EWAI workflow. EWAI doesn’t approve or complete those steps for you.
|
|
63
|
-
|
|
64
|
-
To use the release in a project without replacing a global installation, run:
|
|
29
|
+
To use EWAI in a project without replacing a global installation, run:
|
|
65
30
|
|
|
66
31
|
```bash
|
|
67
32
|
npm install --save-dev @thebackstoryis/engineering-with-ai
|
|
@@ -70,7 +35,7 @@ npx ewai
|
|
|
70
35
|
|
|
71
36
|
To install or update EWAI globally, run `npm install --global @thebackstoryis/engineering-with-ai`.
|
|
72
37
|
|
|
73
|
-
|
|
38
|
+
### Install and start
|
|
74
39
|
|
|
75
40
|
You'll need Node.js 22.5 or newer, npm, and a supported AI command-line tool such as Codex or Claude Code, installed and signed in.
|
|
76
41
|
|
|
@@ -88,12 +53,12 @@ It first asks where to keep your project's SPECS records, then helps you describ
|
|
|
88
53
|
|
|
89
54
|
To return to the project, run `ewai` in the same folder again. It picks up the saved project state rather than starting setup from scratch. Keep your normal Git workflow for your application's code; EWAI itself is installed and updated through npm.
|
|
90
55
|
|
|
91
|
-
If npm returns `E404`, follow [installation troubleshooting](Docs/operations/installation-updating-and-entitlements.md). That's a package-acquisition failure, not a premium-persona licence error. Don't paste licence keys into npm commands or chat.
|
|
56
|
+
If npm returns `E404`, follow [installation troubleshooting](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/operations/installation-updating-and-entitlements.md). That's a package-acquisition failure, not a premium-persona licence error. Don't paste licence keys into npm commands or chat.
|
|
92
57
|
|
|
93
|
-
- [First session: set up a small project](Docs/tutorials/first-session.md)
|
|
94
|
-
- [First delivery: work through a CSV export](Docs/tutorials/first-delivery.md)
|
|
95
|
-
- [Already have a codebase?](Docs/existing-project-onboarding-guide.md) Archaeology can reconstruct missing documentation, but it's your choice whether to run it.
|
|
96
|
-
- [Installation, updates and host options](Docs/operations/installation-updating-and-entitlements.md)
|
|
58
|
+
- [First session: set up a small project](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/tutorials/first-session.md)
|
|
59
|
+
- [First delivery: work through a CSV export](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/tutorials/first-delivery.md)
|
|
60
|
+
- [Already have a codebase?](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/existing-project-onboarding-guide.md) Archaeology can reconstruct missing documentation, but it's your choice whether to run it.
|
|
61
|
+
- [Installation, updates and host options](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/operations/installation-updating-and-entitlements.md)
|
|
97
62
|
|
|
98
63
|
## Start with a conversation
|
|
99
64
|
|
|
@@ -113,7 +78,7 @@ The supporting CLI commands are available for direct control, troubleshooting an
|
|
|
113
78
|
|
|
114
79
|
**SPECS** means Scope, Purpose, Evidence, Constraints and Strategy. These readable project records hold the purpose, requirements, decisions and evidence the team has agreed. They remain useful outside an AI session.
|
|
115
80
|
|
|
116
|
-
The dashboard runs locally and lets you inspect work and make supported choices. Its loopback address isn't a shared team website. The AI host does the guided work; the runtime records progress and checks the conditions for moving on. [How these parts fit together](Docs/explanation/core-concepts.md).
|
|
81
|
+
The dashboard runs locally and lets you inspect work and make supported choices. Its loopback address isn't a shared team website. The AI host does the guided work; the runtime records progress and checks the conditions for moving on. [How these parts fit together](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/explanation/core-concepts.md).
|
|
117
82
|
|
|
118
83
|
Human judgement remains essential. A persona isn't a real stakeholder, green tests aren't human acceptance, and a delivery handoff isn't permission to deploy.
|
|
119
84
|
|
|
@@ -127,21 +92,21 @@ The source is published for transparency and review, but EWAI is not open
|
|
|
127
92
|
source. You may not modify, repackage, redistribute, rebrand or commercially
|
|
128
93
|
exploit the EWAI core without separate written permission from Backstory Group.
|
|
129
94
|
The licence does not restrict the project content or output you create by using
|
|
130
|
-
EWAI. Read the [Backstory Group Source-Available Licence](LICENSE) for the full
|
|
95
|
+
EWAI. Read the [Backstory Group Source-Available Licence](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/LICENSE) for the full
|
|
131
96
|
terms.
|
|
132
97
|
|
|
133
98
|
## Choose what you need
|
|
134
99
|
|
|
135
100
|
| When you want to… | Start here |
|
|
136
101
|
| --- | --- |
|
|
137
|
-
| Decide which work needs attention next | [Companion](Docs/context-aware-delivery-companion-user-guide.md) |
|
|
138
|
-
| Describe a feature and agree its boundaries | [Intent Studio](Docs/guided-intent-workspace-guide.md) |
|
|
139
|
-
| Understand how delivery moves through its stages | [The fourteen-stage workflow](Docs/explanation/delivery-workflow.md) |
|
|
140
|
-
| Investigate dependencies before a change | [Source Map](Docs/repository-source-map-guide.md) and [Blast Radius](Docs/blast-radius-and-impact-routing-guide.md) |
|
|
141
|
-
| Turn a meeting into reviewed project evidence | [Meeting evidence](Docs/meeting-evidence-user-guide.md) |
|
|
142
|
-
| Check an implemented feature with a person | [Manual QA](Docs/quality/manual-qa-and-acceptance.md) |
|
|
143
|
-
| Adapt the dashboard to your work | [Dashboard configuration](Docs/operations/dashboard-configuration.md) |
|
|
144
|
-
| Use shared organisational guidance | [Blueprints](Docs/designing-organisation-blueprint-packs.md) and [rollout](Docs/organisation-rollout-guide.md) |
|
|
102
|
+
| Decide which work needs attention next | [Companion](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/context-aware-delivery-companion-user-guide.md) |
|
|
103
|
+
| Describe a feature and agree its boundaries | [Intent Studio](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/guided-intent-workspace-guide.md) |
|
|
104
|
+
| Understand how delivery moves through its stages | [The fourteen-stage workflow](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/explanation/delivery-workflow.md) |
|
|
105
|
+
| Investigate dependencies before a change | [Source Map](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/repository-source-map-guide.md) and [Blast Radius](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/blast-radius-and-impact-routing-guide.md) |
|
|
106
|
+
| Turn a meeting into reviewed project evidence | [Meeting evidence](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/meeting-evidence-user-guide.md) |
|
|
107
|
+
| Check an implemented feature with a person | [Manual QA](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/quality/manual-qa-and-acceptance.md) |
|
|
108
|
+
| Adapt the dashboard to your work | [Dashboard configuration](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/operations/dashboard-configuration.md) |
|
|
109
|
+
| Use shared organisational guidance | [Blueprints](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/designing-organisation-blueprint-packs.md) and [rollout](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/organisation-rollout-guide.md) |
|
|
145
110
|
|
|
146
111
|
Start with the parts your project needs. Portfolio, Team Hub and other advanced dashboard views are optional; hiding a view doesn't disable mandatory project checks.
|
|
147
112
|
|
|
@@ -149,18 +114,18 @@ Start with the parts your project needs. Portfolio, Team Hub and other advanced
|
|
|
149
114
|
|
|
150
115
|
The included personas support the normal workflow. You can also create project-specific personas and use your own personal library.
|
|
151
116
|
|
|
152
|
-
Premium personas are optional specialist perspectives. If you have a subscription, [enter your key privately and install the pack](Docs/operations/premium-personas-setup.md) before the analysis you want it to support. Installing a persona doesn't give it authority to approve a requirement, bypass a check or speak for a real user.
|
|
117
|
+
Premium personas are optional specialist perspectives. If you have a subscription, [enter your key privately and install the pack](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/operations/premium-personas-setup.md) before the analysis you want it to support. Installing a persona doesn't give it authority to approve a requirement, bypass a check or speak for a real user.
|
|
153
118
|
|
|
154
119
|
## Go deeper
|
|
155
120
|
|
|
156
|
-
- [User guides and learning routes](Docs/README.md)
|
|
157
|
-
- [Complete guide catalogue](Docs/guide-catalogue.md)
|
|
158
|
-
- [Capabilities and project layout](Docs/reference/capabilities-and-project-layout.md)
|
|
159
|
-
- [Commands and configuration](Docs/reference/cli-and-configuration.md)
|
|
160
|
-
- [Troubleshooting and recovery](Docs/operations/troubleshooting-and-recovery.md)
|
|
121
|
+
- [User guides and learning routes](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/README.md)
|
|
122
|
+
- [Complete guide catalogue](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/guide-catalogue.md)
|
|
123
|
+
- [Capabilities and project layout](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/reference/capabilities-and-project-layout.md)
|
|
124
|
+
- [Commands and configuration](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/reference/cli-and-configuration.md)
|
|
125
|
+
- [Troubleshooting and recovery](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/operations/troubleshooting-and-recovery.md)
|
|
161
126
|
- [EWAI on the web: harness overview, online docs and changelog](https://www.conversationalcoding.dev/engineering-with-ai-harness/?utm_source=readme&utm_medium=referral&utm_campaign=ewai)
|
|
162
127
|
- [Engineering With AI, the book behind the method](https://www.conversationalcoding.dev/books/?utm_source=readme&utm_medium=referral&utm_campaign=ewai)
|
|
163
128
|
|
|
164
129
|
## Contributing to EWAI
|
|
165
130
|
|
|
166
|
-
If you're changing the harness itself, use the [contributor guide](Docs/maintainers/contributing.md) and [verification walkthroughs](Docs/maintainers/verification-walkthroughs.md). Those source-checkout and regression-test instructions aren't part of setting up your own application.
|
|
131
|
+
If you're changing the harness itself, use the [contributor guide](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/maintainers/contributing.md) and [verification walkthroughs](https://github.com/TheBackstoryIs/EngineeringWithAIHarness/blob/main/Docs/maintainers/verification-walkthroughs.md). Those source-checkout and regression-test instructions aren't part of setting up your own application.
|
package/package.json
CHANGED