edify-agents-cli 0.2.0__py3-none-any.whl
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.
- edify/__init__.py +19 -0
- edify/__main__.py +6 -0
- edify/_toml.py +286 -0
- edify/agents.py +261 -0
- edify/anim.py +499 -0
- edify/assets/commands/build.md +64 -0
- edify/assets/commands/plan.md +68 -0
- edify/assets/commands/spec.md +63 -0
- edify/assets/commands/tasks.md +65 -0
- edify/assets/commands/verify.md +67 -0
- edify/assets/formats/plan.example.md +455 -0
- edify/assets/formats/plan.format.md +128 -0
- edify/assets/formats/spec.example.md +483 -0
- edify/assets/formats/spec.format.md +116 -0
- edify/assets/formats/tasks.example.md +712 -0
- edify/assets/formats/tasks.format.md +199 -0
- edify/assets/harvest/harvest.md +91 -0
- edify/assets/harvest/sources.md +295 -0
- edify/assets/harvest/vocab.md +52 -0
- edify/assets/manifest.md +30 -0
- edify/assets/mcp/default-registry.md +66 -0
- edify/assets/skills/adversary.md +61 -0
- edify/assets/skills/debugger.md +64 -0
- edify/assets/skills/implementer-general.md +53 -0
- edify/assets/skills/implementer-go.md +63 -0
- edify/assets/skills/implementer-node.md +61 -0
- edify/assets/skills/implementer-postgres.md +63 -0
- edify/assets/skills/implementer-python.md +65 -0
- edify/assets/skills/implementer-react.md +65 -0
- edify/assets/skills/planner.md +58 -0
- edify/assets/skills/test-writer-node.md +64 -0
- edify/assets/skills/test-writer-python.md +60 -0
- edify/assets/skills/verifier.md +67 -0
- edify/assets/templates/CLAUDE.md +18 -0
- edify/assets.py +77 -0
- edify/cli.py +681 -0
- edify/commands/__init__.py +1 -0
- edify/commands/check_cmd.py +72 -0
- edify/commands/doctor_cmd.py +206 -0
- edify/commands/feedback_cmd.py +90 -0
- edify/commands/governance_cmd.py +65 -0
- edify/commands/graph_cmd.py +156 -0
- edify/commands/harvest_cmd.py +538 -0
- edify/commands/init_cmd.py +333 -0
- edify/commands/init_new_cmd.py +151 -0
- edify/commands/license_cmd.py +80 -0
- edify/commands/mcp_cmd.py +159 -0
- edify/commands/self_cmd.py +185 -0
- edify/commands/setup_cmd.py +79 -0
- edify/commands/skills_cmd.py +177 -0
- edify/commands/upgrade_cmd.py +178 -0
- edify/context.py +57 -0
- edify/conventions.py +275 -0
- edify/detect.py +313 -0
- edify/distribution.py +40 -0
- edify/errors.py +66 -0
- edify/feedback.py +207 -0
- edify/formats/__init__.py +11 -0
- edify/formats/check.py +573 -0
- edify/formats/document.py +238 -0
- edify/formats/finding.py +50 -0
- edify/formats/fix.py +114 -0
- edify/formats/mcp.py +126 -0
- edify/formats/plan.py +151 -0
- edify/formats/skill.py +139 -0
- edify/formats/spec.py +164 -0
- edify/formats/tasks.py +321 -0
- edify/governance.py +316 -0
- edify/graph/__init__.py +11 -0
- edify/graph/extract.py +351 -0
- edify/graph/ignore.py +107 -0
- edify/graph/langs/__init__.py +93 -0
- edify/graph/langs/ctags.py +145 -0
- edify/graph/langs/markdown.py +41 -0
- edify/graph/langs/patterns.py +361 -0
- edify/graph/langs/python_ast.py +154 -0
- edify/graph/langs/sqlish.py +86 -0
- edify/graph/model.py +102 -0
- edify/graph/queries.py +211 -0
- edify/graph/store.py +157 -0
- edify/harvest/__init__.py +28 -0
- edify/harvest/ledger.py +191 -0
- edify/harvest/screen.py +236 -0
- edify/harvest/sources.py +298 -0
- edify/host.py +345 -0
- edify/interview.py +354 -0
- edify/library.py +176 -0
- edify/licensing/__init__.py +30 -0
- edify/licensing/ed25519.py +154 -0
- edify/licensing/projects.py +223 -0
- edify/licensing/tier.py +172 -0
- edify/licensing/token.py +149 -0
- edify/paths.py +282 -0
- edify/selfinstall.py +244 -0
- edify/skills.py +108 -0
- edify/tsv.py +109 -0
- edify/ui.py +334 -0
- edify_agents_cli-0.2.0.dist-info/METADATA +408 -0
- edify_agents_cli-0.2.0.dist-info/RECORD +102 -0
- edify_agents_cli-0.2.0.dist-info/WHEEL +4 -0
- edify_agents_cli-0.2.0.dist-info/entry_points.txt +2 -0
- edify_agents_cli-0.2.0.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# The `spec.md` format
|
|
2
|
+
|
|
3
|
+
What is being built and why. One file per feature, read by a human in ten minutes.
|
|
4
|
+
The worked instance is `spec.example.md`; this document is the contract.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Frontmatter
|
|
9
|
+
|
|
10
|
+
Flat, scalars only, five keys.
|
|
11
|
+
|
|
12
|
+
```yaml
|
|
13
|
+
---
|
|
14
|
+
feature: team-invitations
|
|
15
|
+
status: draft # draft | approved | amended
|
|
16
|
+
date: 2026-08-06
|
|
17
|
+
supersedes: — # a spec this one replaces, or —
|
|
18
|
+
brief-source: — # a file or ticket the brief came from, or —
|
|
19
|
+
---
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## The sections, in order
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
# spec — <feature>
|
|
26
|
+
## Brief the ask, verbatim, never edited
|
|
27
|
+
## Intent numbered clauses, one per distinct thing this must accomplish
|
|
28
|
+
## Constraints what is GIVEN: versions, platforms, real commands, hard limits
|
|
29
|
+
## Requirements a table: id · requirement · the assertions that prove it
|
|
30
|
+
## Assertions a table: id · statement · verification kind · citation
|
|
31
|
+
## What this entails the closure checklist — what this implies that nobody asked for
|
|
32
|
+
## Open questions every ambiguity, its readings, the one adopted, who resolves it
|
|
33
|
+
## Non-goals what this explicitly does not do
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## `## Brief`
|
|
37
|
+
|
|
38
|
+
The person's words, unedited. Three lines is normal. It is the only uncontaminated
|
|
39
|
+
statement of intent in the system, and both the adversary and the final review
|
|
40
|
+
check the result against it rather than against the draft that grew out of it.
|
|
41
|
+
|
|
42
|
+
## `## Intent`
|
|
43
|
+
|
|
44
|
+
Numbered clauses. Stable numbering — clauses are appended or struck, never
|
|
45
|
+
renumbered. Every requirement traces to a clause; a clause with no requirement
|
|
46
|
+
serving it is an incomplete spec.
|
|
47
|
+
|
|
48
|
+
## `## Constraints`
|
|
49
|
+
|
|
50
|
+
What is **given**, not chosen: the languages and versions already in use, the
|
|
51
|
+
target platforms and their floors, the package manager and test runner already
|
|
52
|
+
installed, the real build/test/lint/run commands, and the requirements that are not
|
|
53
|
+
up for negotiation.
|
|
54
|
+
|
|
55
|
+
Which library to use, at which version, over which alternative, is a *decision* and
|
|
56
|
+
belongs in `plan.md`. Mixing the two makes a decision look like a law of nature.
|
|
57
|
+
|
|
58
|
+
## `## Requirements`
|
|
59
|
+
|
|
60
|
+
| id | requirement | assertions |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| REQ-1 | An admin can invite someone by email | A-1, A-2, A-3 |
|
|
63
|
+
|
|
64
|
+
A requirement with no assertion is a wish. `edify check` reports it.
|
|
65
|
+
|
|
66
|
+
## `## Assertions`
|
|
67
|
+
|
|
68
|
+
| id | assertion | verification | citation |
|
|
69
|
+
|---|---|---|---|
|
|
70
|
+
| A-1 | An invitation token is 32 characters of base32 | property | src/auth/tokens.ts:14-38 |
|
|
71
|
+
| A-2 | Accepting an expired invitation returns 410 | example | new |
|
|
72
|
+
|
|
73
|
+
**verification** is one of `types` `example` `contract` `property` `model` `proof`
|
|
74
|
+
`observation`, cheapest to strongest. Pick the strongest kind that is *cheap* for
|
|
75
|
+
this assertion, not the strongest available. A pure function or data transformation
|
|
76
|
+
defaults to `property`. Anything expressible in the type system gets `types` in
|
|
77
|
+
addition to whatever else it gets — types are free and additive. Anything at
|
|
78
|
+
`model` or `proof` must be budgeted in `plan.md`, because an unbudgeted model check
|
|
79
|
+
silently becomes an example test during the build and nobody notices.
|
|
80
|
+
|
|
81
|
+
**citation** is `file:line`, `file:line-line`, or the literal `new`. Never a bare
|
|
82
|
+
filename.
|
|
83
|
+
|
|
84
|
+
Phase 2 of the build turns every row here into a failing executable test before any
|
|
85
|
+
code exists. An assertion that cannot become a failing test was never an assertion,
|
|
86
|
+
and the cheapest moment to discover that is while writing this table.
|
|
87
|
+
|
|
88
|
+
## `## What this entails`
|
|
89
|
+
|
|
90
|
+
| id | what it entails | status |
|
|
91
|
+
|---|---|---|
|
|
92
|
+
| CL-1 | The feature is behind a flag | REQ-4 |
|
|
93
|
+
| CL-2 | Invitation emails are rate-limited | open — adversary-found |
|
|
94
|
+
| CL-3 | Personal data has a retention rule | waived — the only datum is an email the admin already holds |
|
|
95
|
+
|
|
96
|
+
Everything the feature implies that nobody asked for: the permission declared and
|
|
97
|
+
requested, the migration and its rollback, the error and empty and loading states,
|
|
98
|
+
the authorization check on the new endpoint, the logs and the alert threshold, the
|
|
99
|
+
translation keys, the retention rule. Each row is satisfied by a requirement,
|
|
100
|
+
deliberately waived with a reason, or open — and an open row is what the human gate
|
|
101
|
+
is for.
|
|
102
|
+
|
|
103
|
+
## `## Open questions`
|
|
104
|
+
|
|
105
|
+
| # | question | readings | adopted | who resolves |
|
|
106
|
+
|---|---|---|---|---|
|
|
107
|
+
|
|
108
|
+
The human either resolves these or accepts the defaults on the record. An
|
|
109
|
+
unresolved question with real consequences blocks the gate; everything else becomes
|
|
110
|
+
a stated assumption and resurfaces in the final review as "we assumed X."
|
|
111
|
+
|
|
112
|
+
## What `edify check` reports
|
|
113
|
+
|
|
114
|
+
A missing required section. A requirement with no assertion. An assertion with no
|
|
115
|
+
verification kind, or one not on the ladder. A citation that is a bare filename. An
|
|
116
|
+
assertion serving no requirement. An open checklist row.
|