levain-cli 0.1.0__tar.gz
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.
- levain_cli-0.1.0/.gitignore +119 -0
- levain_cli-0.1.0/LICENSE +202 -0
- levain_cli-0.1.0/PKG-INFO +77 -0
- levain_cli-0.1.0/README.md +61 -0
- levain_cli-0.1.0/levain_recipe/__init__.py +20 -0
- levain_cli-0.1.0/levain_recipe/__main__.py +6 -0
- levain_cli-0.1.0/levain_recipe/_format.py +45 -0
- levain_cli-0.1.0/levain_recipe/_java.py +95 -0
- levain_cli-0.1.0/levain_recipe/auth.py +322 -0
- levain_cli-0.1.0/levain_recipe/cli.py +344 -0
- levain_cli-0.1.0/levain_recipe/codegen.py +114 -0
- levain_cli-0.1.0/levain_recipe/graph.py +813 -0
- levain_cli-0.1.0/levain_recipe/integrations_check.py +218 -0
- levain_cli-0.1.0/levain_recipe/known_recipes.py +21 -0
- levain_cli-0.1.0/levain_recipe/mcp.py +85 -0
- levain_cli-0.1.0/levain_recipe/models.py +146 -0
- levain_cli-0.1.0/levain_recipe/parser.py +299 -0
- levain_cli-0.1.0/levain_recipe/profile.py +389 -0
- levain_cli-0.1.0/levain_recipe/py.typed +0 -0
- levain_cli-0.1.0/levain_recipe/reducers.py +66 -0
- levain_cli-0.1.0/levain_recipe/source_check.py +279 -0
- levain_cli-0.1.0/levain_recipe/tlc.py +236 -0
- levain_cli-0.1.0/levain_recipe/translate.py +142 -0
- levain_cli-0.1.0/levain_recipe/user_input.py +334 -0
- levain_cli-0.1.0/levain_recipe/validate.py +554 -0
- levain_cli-0.1.0/pyproject.toml +49 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Local secrets
|
|
2
|
+
.secrets
|
|
3
|
+
|
|
4
|
+
# Dependencies
|
|
5
|
+
node_modules/
|
|
6
|
+
|
|
7
|
+
# Terraform
|
|
8
|
+
.terraform/
|
|
9
|
+
terraform.tfstate
|
|
10
|
+
terraform.tfstate.backup
|
|
11
|
+
*.tfvars
|
|
12
|
+
*.tfvars.json
|
|
13
|
+
.terraform.tfstate.lock.info
|
|
14
|
+
|
|
15
|
+
# Built code
|
|
16
|
+
dist/
|
|
17
|
+
build/
|
|
18
|
+
!**/platform_agents/build/
|
|
19
|
+
!**/src/build/
|
|
20
|
+
|
|
21
|
+
# Binaries
|
|
22
|
+
bin/
|
|
23
|
+
|
|
24
|
+
# Packaged code
|
|
25
|
+
*.tgz
|
|
26
|
+
*.zip
|
|
27
|
+
*.tar
|
|
28
|
+
*.tar.gz
|
|
29
|
+
|
|
30
|
+
# Environments
|
|
31
|
+
.env
|
|
32
|
+
*.env
|
|
33
|
+
.venv
|
|
34
|
+
|
|
35
|
+
# Misc
|
|
36
|
+
.DS_Store
|
|
37
|
+
*.log
|
|
38
|
+
|
|
39
|
+
# Python bytecode
|
|
40
|
+
__pycache__/
|
|
41
|
+
*.py[cod]
|
|
42
|
+
*.egg-info/
|
|
43
|
+
|
|
44
|
+
# Test coverage
|
|
45
|
+
.coverage
|
|
46
|
+
.coverage.*
|
|
47
|
+
.pytest_cache/
|
|
48
|
+
htmlcov/
|
|
49
|
+
|
|
50
|
+
# Ruff / MyPy caches
|
|
51
|
+
.ruff_cache/
|
|
52
|
+
.mypy_cache/
|
|
53
|
+
|
|
54
|
+
# VS Code (enable sharing settings)
|
|
55
|
+
!.vscode
|
|
56
|
+
|
|
57
|
+
# Claude Code local settings
|
|
58
|
+
.claude/settings.local.json
|
|
59
|
+
.claude/worktrees/
|
|
60
|
+
|
|
61
|
+
# Skills tooling installed locally via `hyperframes skills` (keep the repo's own skills, e.g. check-pr)
|
|
62
|
+
.agents/
|
|
63
|
+
skills-lock.json
|
|
64
|
+
.claude/skills/*
|
|
65
|
+
!.claude/skills/check-pr/
|
|
66
|
+
|
|
67
|
+
# Knead orchestrator state
|
|
68
|
+
.knead/
|
|
69
|
+
|
|
70
|
+
# Local-mode harness session state (per-session workspace +
|
|
71
|
+
# Claude session map, bind-mounted into the harness + sandbox
|
|
72
|
+
# containers). Path is referenced from local_sandbox.py and
|
|
73
|
+
# docker-compose.yaml; safe to delete to wipe local sessions.
|
|
74
|
+
.levain-cache/
|
|
75
|
+
|
|
76
|
+
# Full-stack marker written by ``./levain init --all``.
|
|
77
|
+
.levain-full
|
|
78
|
+
|
|
79
|
+
# Nested repos (legacy, from old multi-repo setup)
|
|
80
|
+
repos/
|
|
81
|
+
|
|
82
|
+
# Local kubeconfig (legacy path — kubeconfig now lives in
|
|
83
|
+
# ~/.levain/proxy/<env>/kubeconfig). Kept ignored to clean up stale
|
|
84
|
+
# files from older checkouts.
|
|
85
|
+
.kube/
|
|
86
|
+
|
|
87
|
+
# Legacy proxy state (SSH keypair, PIDs). Superseded by
|
|
88
|
+
# ~/.levain/proxy/<env>/. Kept ignored so `git add .` on existing
|
|
89
|
+
# checkouts can't accidentally commit the private key.
|
|
90
|
+
.proxy/
|
|
91
|
+
|
|
92
|
+
# Next.js
|
|
93
|
+
.next/
|
|
94
|
+
next-env.d.ts
|
|
95
|
+
|
|
96
|
+
# Vite
|
|
97
|
+
.vite/
|
|
98
|
+
|
|
99
|
+
# Generated workspace file
|
|
100
|
+
levain.code-workspace
|
|
101
|
+
.gstack/
|
|
102
|
+
.env.local
|
|
103
|
+
.env.development.local
|
|
104
|
+
*.tsbuildinfo
|
|
105
|
+
.eslintcache
|
|
106
|
+
.playwright-mcp/
|
|
107
|
+
|
|
108
|
+
# issue2pr recipe→monitor IPC outcome file (transient, never committed —
|
|
109
|
+
# a tracked copy breaks every other branch's rebase via detach-HEAD conflicts)
|
|
110
|
+
.issue2pr/
|
|
111
|
+
|
|
112
|
+
# Generated PlusCal specs (scratch/example output)
|
|
113
|
+
specs/
|
|
114
|
+
.claude/scheduled_tasks.lock
|
|
115
|
+
.claude/worktrees/
|
|
116
|
+
kubeconfig
|
|
117
|
+
|
|
118
|
+
# Local TLC toolchain drop-in (CI extracts it from the ghcr carrier)
|
|
119
|
+
tools/tla2tools.jar
|
levain_cli-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: levain-cli
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Levain recipe toolchain: PlusCal validator, TLC model checking, and GraphState codegen for agent recipes
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Requires-Python: >=3.12
|
|
8
|
+
Requires-Dist: httpx==0.28.1
|
|
9
|
+
Requires-Dist: pydantic==2.13.4
|
|
10
|
+
Requires-Dist: tree-sitter-tlaplus==1.5.0
|
|
11
|
+
Requires-Dist: tree-sitter==0.26.0
|
|
12
|
+
Requires-Dist: typer==0.26.8
|
|
13
|
+
Provides-Extra: mcp
|
|
14
|
+
Requires-Dist: fastmcp==3.4.7; extra == 'mcp'
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# levain-cli
|
|
18
|
+
|
|
19
|
+
The open toolchain for authoring [Levain](https://levainlabs.com) agent
|
|
20
|
+
recipes: a validator, model checker, and code generator for the PlusCal
|
|
21
|
+
recipe format that Levain agents are defined in.
|
|
22
|
+
|
|
23
|
+
A recipe package is a `graph.tla` PlusCal spec (the agent's node graph
|
|
24
|
+
and state) plus a Python package with one function per node. This tool
|
|
25
|
+
checks both halves and keeps them coherent:
|
|
26
|
+
|
|
27
|
+
- **validate** — parse the spec, enforce the recipe grammar profile,
|
|
28
|
+
check graph topology, translate PlusCal to TLA+, and model-check the
|
|
29
|
+
result with TLC (deadlock and termination).
|
|
30
|
+
- **validate-package** — all of the above, plus Python source
|
|
31
|
+
cross-checks (every `@node` function exists and is importable) and
|
|
32
|
+
`pyproject.toml` checks.
|
|
33
|
+
- **generate-state** — regenerate `_state.py`, the typed `GraphState`
|
|
34
|
+
TypedDict node functions program against.
|
|
35
|
+
|
|
36
|
+
## Install
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
uv tool install levain-cli
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
TLC model checking (stages 4-5) needs a Java runtime; `tla2tools.jar`
|
|
43
|
+
is fetched automatically on first use. Without Java the tool degrades
|
|
44
|
+
to the pure-Python stages and says so — the Levain platform re-runs
|
|
45
|
+
full validation on every push, so nothing is lost, only local
|
|
46
|
+
feedback latency.
|
|
47
|
+
|
|
48
|
+
## Use
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
levain validate graph.tla
|
|
52
|
+
levain validate-package .
|
|
53
|
+
levain generate-state .
|
|
54
|
+
levain --version
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The import package is `levain_recipe` — use it to lint recipes from
|
|
58
|
+
your own CI or scripts:
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
from levain_recipe.validate import validate_fast
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Validation errors are prescriptive (`[stage] line N: message`, with
|
|
65
|
+
TLC counterexample traces) — they are the recipe format's primary
|
|
66
|
+
teaching interface, for humans and agents alike.
|
|
67
|
+
|
|
68
|
+
For MCP clients that cannot run shell commands (e.g. Claude Desktop),
|
|
69
|
+
`levain mcp` serves the same operations over stdio; install
|
|
70
|
+
with the `[mcp]` extra.
|
|
71
|
+
|
|
72
|
+
## What this is not
|
|
73
|
+
|
|
74
|
+
Recipe *execution* — compiling a validated spec into a running agent,
|
|
75
|
+
sandboxing, integrations — happens on the Levain platform. Passing
|
|
76
|
+
local validation is necessary, not sufficient: the platform validates
|
|
77
|
+
again server-side before a version can be published.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# levain-cli
|
|
2
|
+
|
|
3
|
+
The open toolchain for authoring [Levain](https://levainlabs.com) agent
|
|
4
|
+
recipes: a validator, model checker, and code generator for the PlusCal
|
|
5
|
+
recipe format that Levain agents are defined in.
|
|
6
|
+
|
|
7
|
+
A recipe package is a `graph.tla` PlusCal spec (the agent's node graph
|
|
8
|
+
and state) plus a Python package with one function per node. This tool
|
|
9
|
+
checks both halves and keeps them coherent:
|
|
10
|
+
|
|
11
|
+
- **validate** — parse the spec, enforce the recipe grammar profile,
|
|
12
|
+
check graph topology, translate PlusCal to TLA+, and model-check the
|
|
13
|
+
result with TLC (deadlock and termination).
|
|
14
|
+
- **validate-package** — all of the above, plus Python source
|
|
15
|
+
cross-checks (every `@node` function exists and is importable) and
|
|
16
|
+
`pyproject.toml` checks.
|
|
17
|
+
- **generate-state** — regenerate `_state.py`, the typed `GraphState`
|
|
18
|
+
TypedDict node functions program against.
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
uv tool install levain-cli
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
TLC model checking (stages 4-5) needs a Java runtime; `tla2tools.jar`
|
|
27
|
+
is fetched automatically on first use. Without Java the tool degrades
|
|
28
|
+
to the pure-Python stages and says so — the Levain platform re-runs
|
|
29
|
+
full validation on every push, so nothing is lost, only local
|
|
30
|
+
feedback latency.
|
|
31
|
+
|
|
32
|
+
## Use
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
levain validate graph.tla
|
|
36
|
+
levain validate-package .
|
|
37
|
+
levain generate-state .
|
|
38
|
+
levain --version
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
The import package is `levain_recipe` — use it to lint recipes from
|
|
42
|
+
your own CI or scripts:
|
|
43
|
+
|
|
44
|
+
```python
|
|
45
|
+
from levain_recipe.validate import validate_fast
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Validation errors are prescriptive (`[stage] line N: message`, with
|
|
49
|
+
TLC counterexample traces) — they are the recipe format's primary
|
|
50
|
+
teaching interface, for humans and agents alike.
|
|
51
|
+
|
|
52
|
+
For MCP clients that cannot run shell commands (e.g. Claude Desktop),
|
|
53
|
+
`levain mcp` serves the same operations over stdio; install
|
|
54
|
+
with the `[mcp]` extra.
|
|
55
|
+
|
|
56
|
+
## What this is not
|
|
57
|
+
|
|
58
|
+
Recipe *execution* — compiling a validated spec into a running agent,
|
|
59
|
+
sandboxing, integrations — happens on the Levain platform. Passing
|
|
60
|
+
local validation is necessary, not sufficient: the platform validates
|
|
61
|
+
again server-side before a version can be published.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"""Levain recipe toolchain — PlusCal validator + state codegen.
|
|
2
|
+
|
|
3
|
+
The open, client-side half of the Levain recipe toolchain: parse,
|
|
4
|
+
profile and graph checks, PlusCal→TLA+ translation, TLC model
|
|
5
|
+
checking, and ``GraphState`` codegen. Recipe compilation and
|
|
6
|
+
execution stay platform-side, and a pushed version is always
|
|
7
|
+
re-validated there.
|
|
8
|
+
|
|
9
|
+
Import models from ``.models`` and validation functions from
|
|
10
|
+
``.validate`` directly — the validate submodule pulls in
|
|
11
|
+
tree-sitter and other heavy deps, and keeping ``__init__`` empty
|
|
12
|
+
lets light callers (version reporting, service health checks)
|
|
13
|
+
avoid them.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
# The recipe *language* version — bumped when the grammar profile
|
|
17
|
+
# or annotation vocabulary changes, independently of tool
|
|
18
|
+
# releases. The API's toolchain handshake compares this against
|
|
19
|
+
# the server's copy.
|
|
20
|
+
LANGUAGE_VERSION = "1.0"
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"""Validation-result formatting shared by the CLI and MCP server.
|
|
2
|
+
|
|
3
|
+
The exact output strings are load-bearing: build agents parse the
|
|
4
|
+
``VALIDATION FAILED``/``VALIDATION PASSED`` headers and per-error
|
|
5
|
+
``[stage] line N: message`` lines. Change them only with a
|
|
6
|
+
language-version bump.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from __future__ import annotations
|
|
10
|
+
|
|
11
|
+
from .models import ValidatedSpec, ValidationError
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def format_error(err: ValidationError) -> str:
|
|
15
|
+
"""Format a single error for the builder to parse."""
|
|
16
|
+
loc = f" line {err.line}:" if err.line else ":"
|
|
17
|
+
line = f"[{err.stage}]{loc} {err.message}"
|
|
18
|
+
if err.counterexample:
|
|
19
|
+
line += "\n Counterexample:"
|
|
20
|
+
for step in err.counterexample:
|
|
21
|
+
line += f"\n {step}"
|
|
22
|
+
return line
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def format_errors(errors: list[ValidationError]) -> str:
|
|
26
|
+
"""Format all errors into structured output."""
|
|
27
|
+
n = len(errors)
|
|
28
|
+
noun = "error" if n == 1 else "errors"
|
|
29
|
+
header = f"VALIDATION FAILED ({n} {noun})\n"
|
|
30
|
+
body = "\n".join(format_error(e) for e in errors)
|
|
31
|
+
return f"{header}\n{body}\n\nFix these errors and regenerate the spec."
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def format_success(spec: ValidatedSpec) -> str:
|
|
35
|
+
"""Format the success summary."""
|
|
36
|
+
nodes = ", ".join(n.label for n in spec.nodes)
|
|
37
|
+
transitions = sum(len(r.routes) for r in spec.routing)
|
|
38
|
+
invariants = ", ".join(spec.invariants) if spec.invariants else "(none)"
|
|
39
|
+
return (
|
|
40
|
+
f"VALIDATION PASSED\n\n"
|
|
41
|
+
f"Module: {spec.module_name}\n"
|
|
42
|
+
f"Nodes: {nodes}\n"
|
|
43
|
+
f"Transitions: {transitions}\n"
|
|
44
|
+
f"Invariants: {invariants}"
|
|
45
|
+
)
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
"""Shared Java/tla2tools.jar helpers for stages 4-5."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import re
|
|
7
|
+
import shutil
|
|
8
|
+
import sys
|
|
9
|
+
import urllib.request
|
|
10
|
+
from pathlib import Path
|
|
11
|
+
|
|
12
|
+
from .models import ValidationError
|
|
13
|
+
|
|
14
|
+
RE_MODULE_NAME = re.compile(r"^[a-zA-Z_]\w*$")
|
|
15
|
+
|
|
16
|
+
TLA2TOOLS_VERSION = "1.8.0"
|
|
17
|
+
# Upstream release assets are mutable (re-uploaded in place before);
|
|
18
|
+
# service images therefore pin the jar via a ghcr carrier image.
|
|
19
|
+
# This URL is only the client-side convenience fetch — best-effort,
|
|
20
|
+
# and the platform re-validates server-side regardless.
|
|
21
|
+
_JAR_URL = (
|
|
22
|
+
"https://github.com/tlaplus/tlaplus/releases/download/"
|
|
23
|
+
f"v{TLA2TOOLS_VERSION}/tla2tools.jar"
|
|
24
|
+
)
|
|
25
|
+
_JAR_CACHE = Path.home() / ".local" / "share" / "tla" / "tla2tools.jar"
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def resolve_jar() -> str | None:
|
|
29
|
+
"""Find tla2tools.jar.
|
|
30
|
+
|
|
31
|
+
Order: ``TLA2TOOLS_JAR`` env var (service images set it),
|
|
32
|
+
``tools/tla2tools.jar`` relative to a source checkout (CI
|
|
33
|
+
extracts the ghcr carrier there), then the user cache that
|
|
34
|
+
:func:`ensure_jar` fills.
|
|
35
|
+
"""
|
|
36
|
+
env = os.environ.get("TLA2TOOLS_JAR")
|
|
37
|
+
if env:
|
|
38
|
+
path = os.path.normpath(env)
|
|
39
|
+
if os.path.isfile(path):
|
|
40
|
+
return path
|
|
41
|
+
return None
|
|
42
|
+
repo_tools = os.path.normpath(
|
|
43
|
+
os.path.join(
|
|
44
|
+
os.path.dirname(__file__),
|
|
45
|
+
"..",
|
|
46
|
+
"..",
|
|
47
|
+
"..",
|
|
48
|
+
"tools",
|
|
49
|
+
"tla2tools.jar",
|
|
50
|
+
)
|
|
51
|
+
)
|
|
52
|
+
if os.path.isfile(repo_tools):
|
|
53
|
+
return repo_tools
|
|
54
|
+
if _JAR_CACHE.is_file():
|
|
55
|
+
return str(_JAR_CACHE)
|
|
56
|
+
return None
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
def ensure_jar() -> str | None:
|
|
60
|
+
"""Resolve the jar, downloading to the user cache on first use.
|
|
61
|
+
|
|
62
|
+
CLI/MCP-only convenience — library callers use
|
|
63
|
+
:func:`resolve_jar` so validation never does network I/O.
|
|
64
|
+
"""
|
|
65
|
+
found = resolve_jar()
|
|
66
|
+
if found is not None:
|
|
67
|
+
return found
|
|
68
|
+
|
|
69
|
+
_JAR_CACHE.parent.mkdir(parents=True, exist_ok=True)
|
|
70
|
+
tmp = _JAR_CACHE.with_suffix(".part")
|
|
71
|
+
print(
|
|
72
|
+
f"Fetching tla2tools.jar {TLA2TOOLS_VERSION} (one-time)...",
|
|
73
|
+
file=sys.stderr,
|
|
74
|
+
)
|
|
75
|
+
try:
|
|
76
|
+
urllib.request.urlretrieve(_JAR_URL, tmp)
|
|
77
|
+
tmp.replace(_JAR_CACHE)
|
|
78
|
+
except OSError as exc:
|
|
79
|
+
tmp.unlink(missing_ok=True)
|
|
80
|
+
print(f"Could not fetch tla2tools.jar: {exc}", file=sys.stderr)
|
|
81
|
+
return None
|
|
82
|
+
return str(_JAR_CACHE)
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
def require_java(stage: str) -> str | list[ValidationError]:
|
|
86
|
+
"""Return the java binary path, or a ValidationError."""
|
|
87
|
+
java = shutil.which("java")
|
|
88
|
+
if java is None:
|
|
89
|
+
return [
|
|
90
|
+
ValidationError(
|
|
91
|
+
stage=stage,
|
|
92
|
+
message="Java not found.",
|
|
93
|
+
)
|
|
94
|
+
]
|
|
95
|
+
return java
|