Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

Commit 8a3af52

Browse files
committed
docs: add section about cmserve to the readme
1 parent 48f6c05 commit 8a3af52

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,16 @@ quit
188188
exit
189189
```
190190

191+
## JSON Interface
192+
193+
From `v0.2.0`, Coreminer includes a second binary: `cmserve`. `cmserve` provides
194+
all internal functionalities of the Coreminer debugger, but can be
195+
scripted. This enables projects such as [hardhat](https://github.com/debugger-bd/hardhat)
196+
to build a better user interface for Coreminer.
197+
198+
To see some example inputs (statuses) and outputs (feedbacks), you can use
199+
`cmserve --example-statuses --example-feedbacks `.
200+
191201
## Use Cases
192202

193203
- **Reverse Engineering**: Analyze and understand program behavior

0 commit comments

Comments
 (0)