matvenus-cli 0.1.0
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/CHANGELOG.md +22 -0
- package/LICENSE +201 -0
- package/README.md +408 -0
- package/bin/cli.js +3 -0
- package/dist/client.d.ts +13 -0
- package/dist/client.js +62 -0
- package/dist/commands/alphafold_protein_folding.d.ts +2 -0
- package/dist/commands/alphafold_protein_folding.js +262 -0
- package/dist/commands/cancel_tool_result.d.ts +2 -0
- package/dist/commands/cancel_tool_result.js +388 -0
- package/dist/commands/diffdock_protein_ligand_docking.d.ts +2 -0
- package/dist/commands/diffdock_protein_ligand_docking.js +252 -0
- package/dist/commands/esmfold_protein_folding.d.ts +2 -0
- package/dist/commands/esmfold_protein_folding.js +219 -0
- package/dist/commands/get_tool_result.d.ts +2 -0
- package/dist/commands/get_tool_result.js +388 -0
- package/dist/commands/gromacs_analysis.d.ts +2 -0
- package/dist/commands/gromacs_analysis.js +212 -0
- package/dist/commands/gromacs_md.d.ts +2 -0
- package/dist/commands/gromacs_md.js +236 -0
- package/dist/commands/index.d.ts +2 -0
- package/dist/commands/index.js +39 -0
- package/dist/commands/predict_functional_residue.d.ts +2 -0
- package/dist/commands/predict_functional_residue.js +234 -0
- package/dist/commands/predict_protein_properties.d.ts +2 -0
- package/dist/commands/predict_protein_properties.js +228 -0
- package/dist/commands/proteinmpnn_sequence_design.d.ts +2 -0
- package/dist/commands/proteinmpnn_sequence_design.js +271 -0
- package/dist/commands/rfdiffusion_protein_design.d.ts +2 -0
- package/dist/commands/rfdiffusion_protein_design.js +333 -0
- package/dist/commands/upload_file_base_64.d.ts +2 -0
- package/dist/commands/upload_file_base_64.js +212 -0
- package/dist/commands/venusg_protein_function_prediction.d.ts +2 -0
- package/dist/commands/venusg_protein_function_prediction.js +234 -0
- package/dist/commands/venusmine_protein_mining.d.ts +2 -0
- package/dist/commands/venusmine_protein_mining.js +212 -0
- package/dist/commands/venusprime_multipoint_prediction.d.ts +2 -0
- package/dist/commands/venusprime_multipoint_prediction.js +322 -0
- package/dist/commands/venusrem_mutation_prediction.d.ts +2 -0
- package/dist/commands/venusrem_mutation_prediction.js +260 -0
- package/dist/commands/venusx_functional_residue_prediction.d.ts +2 -0
- package/dist/commands/venusx_functional_residue_prediction.js +234 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +125 -0
- package/dist/types.d.ts +12 -0
- package/dist/types.js +6 -0
- package/package.json +41 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.1.0] - 2026-03-30
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Initial project release.
|
|
12
|
+
- Support for protein folding prediction (AlphaFold2, AlphaFold3, ESMFold).
|
|
13
|
+
- Support for functional residue prediction (ESM2, VenusX).
|
|
14
|
+
- Support for protein function prediction (VenusG).
|
|
15
|
+
- Support for mutation prediction (VenusREM, VenusPrime).
|
|
16
|
+
- Support for molecular dynamics simulations (GROMACS).
|
|
17
|
+
- Support for de novo protein design (RFdiffusion, ProteinMPNN).
|
|
18
|
+
- Support for protein mining (VenusMine).
|
|
19
|
+
- Standardized CLI interface with `commander.js`.
|
|
20
|
+
|
|
21
|
+
### Changed
|
|
22
|
+
- Preparation for NPM publication.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
# matvenus-cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for the VenusFactory Protein Tools API. Provides access to protein structure prediction, mutation analysis, molecular dynamics, and de novo protein design via the VenusFactory MCP server.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install
|
|
9
|
+
npm run build
|
|
10
|
+
npm link # optional: install globally as `matvenus-cli`
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Authentication
|
|
14
|
+
|
|
15
|
+
Set the Bearer token via environment variable before running any command:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
export API_BEARER_TOKEN="your-api-key-here"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Base URL
|
|
22
|
+
|
|
23
|
+
The default base URL is `https://venus.matwings.com`. Override per-command with `--base-url <url>`.
|
|
24
|
+
|
|
25
|
+
## Async Execution Pattern
|
|
26
|
+
|
|
27
|
+
**All compute-heavy commands are asynchronous.** They return immediately with:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"tool_call_id": "abc-123",
|
|
32
|
+
"status": "pending",
|
|
33
|
+
"tool_name": "alphafold_protein_folding"
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
You must poll `get-tool-result` until `status` is `success` or `error`:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Submit job
|
|
41
|
+
matvenus-cli alphafold-protein-folding --body '{"sequence": "MKTAYIAKQ..."}'
|
|
42
|
+
|
|
43
|
+
# Poll for result (repeat until status = success)
|
|
44
|
+
matvenus-cli get-tool-result --tool-call-id abc-123
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Status values: `pending` → `running` → `success` | `error`
|
|
48
|
+
|
|
49
|
+
## Uploading Local Files
|
|
50
|
+
|
|
51
|
+
Many commands accept `fasta_file`, `pdb_file`, etc. as OSS URLs. To use a local file:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
# 1. Base64-encode the file
|
|
55
|
+
CONTENT=$(base64 -w 0 my_protein.fasta)
|
|
56
|
+
|
|
57
|
+
# 2. Upload and get OSS URL
|
|
58
|
+
matvenus-cli upload-file-base-64 \
|
|
59
|
+
--body "{\"filename\": \"my_protein.fasta\", \"content_base64\": \"$CONTENT\"}"
|
|
60
|
+
# Returns: result.url = "oss://bucket/..."
|
|
61
|
+
|
|
62
|
+
# 3. Use the URL in prediction commands
|
|
63
|
+
matvenus-cli alphafold-protein-folding \
|
|
64
|
+
--body '{"fasta_file": "oss://bucket/..."}'
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Commands
|
|
68
|
+
|
|
69
|
+
### Functional Residue Prediction
|
|
70
|
+
|
|
71
|
+
#### `predict-functional-residue`
|
|
72
|
+
Predict functional residues (activity/binding/conserved sites, motifs).
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
matvenus-cli predict-functional-residue --body '{
|
|
76
|
+
"sequence": "MKTAYIAKQRQISFVKSHFSRQ...",
|
|
77
|
+
"model_name": "ESM2-650M",
|
|
78
|
+
"task": "Activity Site"
|
|
79
|
+
}'
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
| Parameter | Type | Default | Options |
|
|
83
|
+
|-----------|------|---------|---------|
|
|
84
|
+
| sequence | string \| null | — | Inline amino acid sequence |
|
|
85
|
+
| fasta_file | string \| null | — | OSS URL to FASTA file |
|
|
86
|
+
| model_name | string | `ESM2-650M` | `ESM2-650M`, `Ankh-large`, `ProtT5-xl-uniref50` |
|
|
87
|
+
| task | string | `Activity Site` | `Activity Site`, `Binding Site`, `Conserved Site`, `Motif` |
|
|
88
|
+
|
|
89
|
+
#### `venusx-functional-residue-prediction`
|
|
90
|
+
VenusX model for functional site prediction (higher accuracy than base model).
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
matvenus-cli venusx-functional-residue-prediction --body '{
|
|
94
|
+
"sequence": "MKTAYIAKQ...",
|
|
95
|
+
"task": "VenusX-Activity",
|
|
96
|
+
"mode": "pro"
|
|
97
|
+
}'
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
| Parameter | Type | Default | Options |
|
|
101
|
+
|-----------|------|---------|---------|
|
|
102
|
+
| sequence | string \| null | — | |
|
|
103
|
+
| fasta_file | string \| null | — | OSS URL |
|
|
104
|
+
| task | string | `VenusX-Activity` | `VenusX-Activity`, `VenusX-Binding`, `VenusX-Evo` |
|
|
105
|
+
| mode | string | `pro` | `pro` (Ankh-large), `light` (ESM2-650M) |
|
|
106
|
+
|
|
107
|
+
### Protein Function Prediction
|
|
108
|
+
|
|
109
|
+
#### `venusg-protein-function-prediction`
|
|
110
|
+
Predict protein-level properties: solubility, localization, stability, kinetics, etc.
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
matvenus-cli venusg-protein-function-prediction --body '{
|
|
114
|
+
"sequence": "MKTAYIAKQ...",
|
|
115
|
+
"task": "VenusG-Solubility",
|
|
116
|
+
"mode": "light"
|
|
117
|
+
}'
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
| Parameter | Type | Default | Options |
|
|
121
|
+
|-----------|------|---------|---------|
|
|
122
|
+
| sequence | string \| null | — | |
|
|
123
|
+
| fasta_file | string \| null | — | OSS URL |
|
|
124
|
+
| task | string | `VenusG-Solubility` | `VenusG-Solubility`, `VenusG-SubcellularLocalization`, `VenusG-MembraneProtein`, `VenusG-Metalionbinding`, `VenusG-Stability`, `VenusG-Sortingsignal`, `VenusG-OptimumTemperature`, `VenusG-Kcat`, `VenusG-OptimalPH` |
|
|
125
|
+
| mode | string | `light` | `pro` (ESM2-650M), `light` (ProtBert) |
|
|
126
|
+
|
|
127
|
+
#### `predict-protein-properties`
|
|
128
|
+
Calculate physicochemical properties and structural features.
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
matvenus-cli predict-protein-properties --body '{
|
|
132
|
+
"sequence": "MKTAYIAKQ...",
|
|
133
|
+
"task_name": "Physical and chemical properties"
|
|
134
|
+
}'
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
| Parameter | Type | Default | Options |
|
|
138
|
+
|-----------|------|---------|---------|
|
|
139
|
+
| sequence | string \| null | — | |
|
|
140
|
+
| fasta_file | string \| null | — | OSS URL to FASTA or PDB |
|
|
141
|
+
| task_name | string | `Physical and chemical properties` | `Physical and chemical properties`, `Relative solvent accessible surface area (PDB only)`, `SASA value (PDB only)`, `Secondary structure (PDB only)` |
|
|
142
|
+
|
|
143
|
+
### Structure Prediction
|
|
144
|
+
|
|
145
|
+
#### `esmfold-protein-folding`
|
|
146
|
+
Fast protein structure prediction using ESMFold (sequence only, no MSA).
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
matvenus-cli esmfold-protein-folding --body '{
|
|
150
|
+
"sequence": "MKTAYIAKQRQISFVKSHFSRQ"
|
|
151
|
+
}'
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
| Parameter | Required | Default |
|
|
155
|
+
|-----------|----------|---------|
|
|
156
|
+
| sequence | yes | — |
|
|
157
|
+
| verbose | no | `true` |
|
|
158
|
+
|
|
159
|
+
#### `alphafold-protein-folding`
|
|
160
|
+
High-accuracy structure prediction with AlphaFold2 or AlphaFold3.
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
# Single chain (AF2)
|
|
164
|
+
matvenus-cli alphafold-protein-folding --body '{
|
|
165
|
+
"model_version": "alphafold2",
|
|
166
|
+
"sequence": "MKTAYIAKQ..."
|
|
167
|
+
}'
|
|
168
|
+
|
|
169
|
+
# Multi-chain complex with ligand (AF3)
|
|
170
|
+
matvenus-cli alphafold-protein-folding --body '{
|
|
171
|
+
"model_version": "alphafold3",
|
|
172
|
+
"sequences": [
|
|
173
|
+
{"protein": {"id": "A", "sequence": "MKTAYIAKQ..."}},
|
|
174
|
+
{"ligand": {"id": "Z", "ccdCodes": ["ATP"]}}
|
|
175
|
+
],
|
|
176
|
+
"model_seeds": [42]
|
|
177
|
+
}'
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
| Parameter | Type | Default | Description |
|
|
181
|
+
|-----------|------|---------|-------------|
|
|
182
|
+
| model_version | string | `alphafold2` | `alphafold2` or `alphafold3` |
|
|
183
|
+
| sequence | string \| null | — | Single-chain sequence (AF2/AF3 simple) |
|
|
184
|
+
| fasta_file | string \| null | — | OSS URL to FASTA |
|
|
185
|
+
| sequences | array \| null | — | Multi-chain/ligand entities (see schema) |
|
|
186
|
+
| model_seeds | int[] \| null | `[42]` | Random seeds (AF3 only) |
|
|
187
|
+
|
|
188
|
+
### Mutation Prediction
|
|
189
|
+
|
|
190
|
+
#### `venusrem-mutation-prediction`
|
|
191
|
+
Single-point mutation effect prediction using multi-model ensemble.
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
# Light mode (sequence-based)
|
|
195
|
+
matvenus-cli venusrem-mutation-prediction --body '{
|
|
196
|
+
"task": "stability",
|
|
197
|
+
"mode": "light",
|
|
198
|
+
"sequence": "MKTAYIAKQ..."
|
|
199
|
+
}'
|
|
200
|
+
|
|
201
|
+
# Pro mode (structure-based, higher accuracy)
|
|
202
|
+
matvenus-cli venusrem-mutation-prediction --body '{
|
|
203
|
+
"task": "activity",
|
|
204
|
+
"mode": "pro",
|
|
205
|
+
"structure_file": "oss://bucket/protein.pdb"
|
|
206
|
+
}'
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
| Parameter | Required | Options |
|
|
210
|
+
|-----------|----------|---------|
|
|
211
|
+
| task | yes | `activity`, `binding`, `stability`, `expression`, `general` |
|
|
212
|
+
| mode | yes | `pro` (structure-based), `light` (sequence-based) |
|
|
213
|
+
| structure_file | pro mode | OSS URL to PDB |
|
|
214
|
+
| sequence | light mode | Inline sequence |
|
|
215
|
+
| fasta_file | light mode | OSS URL to FASTA |
|
|
216
|
+
|
|
217
|
+
#### `venusprime-multipoint-prediction`
|
|
218
|
+
Multi-point combination mutation prediction using trained ensemble models.
|
|
219
|
+
|
|
220
|
+
Two-step workflow: **train** → **inference**
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
# Step 1: Train models from experimental data
|
|
224
|
+
matvenus-cli venusprime-multipoint-prediction --body '{
|
|
225
|
+
"mode": "train",
|
|
226
|
+
"sequence": "MKTAYIAKQ...",
|
|
227
|
+
"experiment_file": "oss://bucket/mutations.csv",
|
|
228
|
+
"score_col_name": "fitness",
|
|
229
|
+
"model_num": 5
|
|
230
|
+
}'
|
|
231
|
+
# Returns tool_call_id; poll until success; result contains model_path_list
|
|
232
|
+
|
|
233
|
+
# Step 2: Inference on combination mutations
|
|
234
|
+
matvenus-cli venusprime-multipoint-prediction --body '{
|
|
235
|
+
"mode": "inference",
|
|
236
|
+
"model_path_list": ["oss://bucket/model_0.pkl", "..."],
|
|
237
|
+
"site": [10, 25, 42]
|
|
238
|
+
}'
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
| Parameter | Type | Default | Description |
|
|
242
|
+
|-----------|------|---------|-------------|
|
|
243
|
+
| mode | string | `inference` | `train` or `inference` |
|
|
244
|
+
| venus_mode | string | `light` | `light` (ridge regression) |
|
|
245
|
+
| sequence | string \| null | — | Wild-type sequence (train) |
|
|
246
|
+
| fasta_file | string \| null | — | OSS URL to FASTA (train) |
|
|
247
|
+
| experiment_file | string \| null | — | OSS URL to CSV with `mutant`+`score` cols (train) |
|
|
248
|
+
| score_col_name | string | — | Score column name in experiment_file |
|
|
249
|
+
| model_path_list | string[] \| null | — | Trained model OSS URLs (inference) |
|
|
250
|
+
| site | int[] \| null | `[2,3,4]` | Mutation site positions (inference) |
|
|
251
|
+
| model_num | int | `5` | Ensemble model count (train) |
|
|
252
|
+
| target_server | string | `slurm` | `slurm` or `paracloud` |
|
|
253
|
+
|
|
254
|
+
### Molecular Dynamics
|
|
255
|
+
|
|
256
|
+
#### `gromacs-md`
|
|
257
|
+
Run GROMACS MD simulation (system build + production run).
|
|
258
|
+
|
|
259
|
+
```bash
|
|
260
|
+
matvenus-cli gromacs-md --body '{
|
|
261
|
+
"pdb_file": "oss://bucket/protein.pdb",
|
|
262
|
+
"force_field": "amber99sb-ildn",
|
|
263
|
+
"water_model": "tip3p",
|
|
264
|
+
"temp": "300",
|
|
265
|
+
"md_steps": "50000"
|
|
266
|
+
}'
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
| Parameter | Required | Default |
|
|
270
|
+
|-----------|----------|---------|
|
|
271
|
+
| pdb_file | yes | OSS URL to PDB |
|
|
272
|
+
| force_field | no | `amber99sb-ildn` |
|
|
273
|
+
| water_model | no | `tip3p` |
|
|
274
|
+
| temp | no | `300` (K) |
|
|
275
|
+
| pressure | no | `1.0` (bar) |
|
|
276
|
+
| md_steps | no | `50000` (~100ps at dt=2fs) |
|
|
277
|
+
|
|
278
|
+
#### `gromacs-analysis`
|
|
279
|
+
Analyze GROMACS MD trajectory (RMSD, RMSF, Rg, etc.).
|
|
280
|
+
|
|
281
|
+
Requires output from a completed `gromacs-md` run.
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
matvenus-cli gromacs-analysis --body '{
|
|
285
|
+
"tpr_file": "oss://bucket/md.tpr",
|
|
286
|
+
"xtc_file": "oss://bucket/md.xtc"
|
|
287
|
+
}'
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Protein Mining & Design
|
|
291
|
+
|
|
292
|
+
#### `venusmine-protein-mining`
|
|
293
|
+
Mine novel protein variants from structure-based screening.
|
|
294
|
+
|
|
295
|
+
```bash
|
|
296
|
+
matvenus-cli venusmine-protein-mining --body '{
|
|
297
|
+
"pdb_file": "oss://bucket/protein.pdb",
|
|
298
|
+
"target_server": "slurm"
|
|
299
|
+
}'
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
#### `proteinmpnn-sequence-design`
|
|
303
|
+
Design sequences for a given protein backbone using ProteinMPNN.
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
matvenus-cli proteinmpnn-sequence-design --body '{
|
|
307
|
+
"pdb_path": "oss://bucket/backbone.pdb",
|
|
308
|
+
"designed_chains": ["A"],
|
|
309
|
+
"fixed_chains": ["B"],
|
|
310
|
+
"num_sequences": 4,
|
|
311
|
+
"temperatures": [0.1]
|
|
312
|
+
}'
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
| Parameter | Type | Default | Description |
|
|
316
|
+
|-----------|------|---------|-------------|
|
|
317
|
+
| pdb_path | string | — | OSS URL to PDB (required) |
|
|
318
|
+
| designed_chains | string[] \| null | — | Chains to redesign |
|
|
319
|
+
| fixed_chains | string[] \| null | — | Chains to keep fixed |
|
|
320
|
+
| num_sequences | int | `4` | Sequences to generate |
|
|
321
|
+
| temperatures | float[] | `[0.1]` | Sampling temperatures |
|
|
322
|
+
| omit_aas | string | `X` | Amino acids to exclude |
|
|
323
|
+
| homomer | bool | `false` | Symmetric homomer design |
|
|
324
|
+
| ca_only | bool | `false` | Cα-only backbone |
|
|
325
|
+
|
|
326
|
+
#### `rfdiffusion-protein-design`
|
|
327
|
+
De novo protein structure generation using RFdiffusion.
|
|
328
|
+
|
|
329
|
+
```bash
|
|
330
|
+
# Unconditional generation
|
|
331
|
+
matvenus-cli rfdiffusion-protein-design --body '{
|
|
332
|
+
"length": "100",
|
|
333
|
+
"num_designs": 3
|
|
334
|
+
}'
|
|
335
|
+
|
|
336
|
+
# Motif scaffolding
|
|
337
|
+
matvenus-cli rfdiffusion-protein-design --body '{
|
|
338
|
+
"input_pdb": "oss://bucket/motif.pdb",
|
|
339
|
+
"contig": "A10-20,80",
|
|
340
|
+
"num_designs": 5
|
|
341
|
+
}'
|
|
342
|
+
|
|
343
|
+
# Binder design
|
|
344
|
+
matvenus-cli rfdiffusion-protein-design --body '{
|
|
345
|
+
"input_pdb": "oss://bucket/target.pdb",
|
|
346
|
+
"hotspots": "A10,A15,A20",
|
|
347
|
+
"length": "80-120"
|
|
348
|
+
}'
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
| Parameter | Type | Default | Description |
|
|
352
|
+
|-----------|------|---------|-------------|
|
|
353
|
+
| input_pdb | string \| null | — | OSS URL (optional for unconditional) |
|
|
354
|
+
| contig | string \| null | — | Contig string, e.g. `A10-20,80` |
|
|
355
|
+
| num_designs | int | `1` | Designs to generate |
|
|
356
|
+
| length | string \| null | — | Length constraint, e.g. `100` or `80-120` |
|
|
357
|
+
| hotspots | string \| null | — | Hotspot residues, e.g. `A10,A15` |
|
|
358
|
+
| partial_t | float \| null | — | Noise level for partial diffusion (Å) |
|
|
359
|
+
| T | int | `50` | Diffusion steps |
|
|
360
|
+
|
|
361
|
+
### File Upload
|
|
362
|
+
|
|
363
|
+
#### `upload-file-base-64`
|
|
364
|
+
Upload a local file to OSS storage and get a URL for use in other commands.
|
|
365
|
+
|
|
366
|
+
```bash
|
|
367
|
+
CONTENT=$(base64 -w 0 protein.fasta)
|
|
368
|
+
matvenus-cli upload-file-base-64 --body "{
|
|
369
|
+
\"filename\": \"protein.fasta\",
|
|
370
|
+
\"content_base64\": \"$CONTENT\"
|
|
371
|
+
}"
|
|
372
|
+
# Response: result.url = OSS URL to use in other commands
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Result Management
|
|
376
|
+
|
|
377
|
+
#### `get-tool-result`
|
|
378
|
+
Poll for the result of an async job.
|
|
379
|
+
|
|
380
|
+
```bash
|
|
381
|
+
matvenus-cli get-tool-result --tool-call-id <tool_call_id>
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
Response includes `status` (`pending`/`running`/`success`/`error`), `tool_result` (on success), and `slurm_tasks` with per-job details.
|
|
385
|
+
|
|
386
|
+
#### `cancel-tool-result`
|
|
387
|
+
Cancel a pending or running job.
|
|
388
|
+
|
|
389
|
+
```bash
|
|
390
|
+
matvenus-cli cancel-tool-result --tool-call-id <tool_call_id>
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
## Global Options
|
|
394
|
+
|
|
395
|
+
All commands support:
|
|
396
|
+
|
|
397
|
+
| Option | Description |
|
|
398
|
+
|--------|-------------|
|
|
399
|
+
| `--base-url <url>` | Override default base URL |
|
|
400
|
+
| `--output json\|table` | Output format (default: `json`) |
|
|
401
|
+
| `--schema` | Print the API schema for this command and exit |
|
|
402
|
+
|
|
403
|
+
## Inspect Command Schema
|
|
404
|
+
|
|
405
|
+
```bash
|
|
406
|
+
matvenus-cli alphafold-protein-folding --schema
|
|
407
|
+
matvenus-cli venusrem-mutation-prediction --schema
|
|
408
|
+
```
|
package/bin/cli.js
ADDED
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export interface ApiClientConfig {
|
|
2
|
+
baseUrl: string;
|
|
3
|
+
}
|
|
4
|
+
export interface RequestOptions {
|
|
5
|
+
method: string;
|
|
6
|
+
path: string;
|
|
7
|
+
headers?: Record<string, string>;
|
|
8
|
+
body?: any;
|
|
9
|
+
isBinary?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export declare function request(config: ApiClientConfig, options: RequestOptions): Promise<any>;
|
|
12
|
+
export declare function buildPath(template: string, params: Record<string, any>): string;
|
|
13
|
+
export declare function buildQuery(params: Record<string, any>): string;
|