Skip to content

Commit 4d887d8

Browse files
committed
[cli] Update docs
1 parent c3694e2 commit 4d887d8

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ Developers:
117117

118118
## See Also
119119

120+
- Experimental CLI [README](cli/README.md)
120121
- [Project blog][Blog]
121122
- License: see LICENSE
122123
- Contributing: see CONTRIBUTING.md
@@ -132,5 +133,3 @@ Developers:
132133
[HAL]: https://github.com/cardano-foundation/hal
133134
[CF]: https://github.com/cardano-foundation
134135
[Cardano]: https://cardano.org/
135-
136-

cli/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,6 @@ nix shell github:cardano-foundation/antithesis?dir=cli#anti
3333

3434
### Building the tarballs
3535

36-
To build standalone packages with
37-
- anti
38-
- cardano-cli
39-
- cardano-address
40-
- bech32
41-
4236
On linux, you can build a nix derivation with
4337

4438
```bash
@@ -60,7 +54,7 @@ source <(anti --bash-completion-script "$(which anti)")
6054
antij() {
6155
result=$(anti "$@")
6256
if [ "$(echo "$result" | jq '.error')" != "null" ]; then
63-
echo "$result" | jq
57+
echo "$result" | jq
6458
else
6559
echo "$result" | jq '.result'
6660
fi
@@ -122,7 +116,6 @@ This is the unique token that identifies the Antithesis access interface. You ne
122116
export ANTI_TOKEN_ID=865ebcf5e1d6bafcc121030a6e167474a426271d965b78e36d90485adf540575
123117
```
124118

125-
126119
### Set the timeout for the `anti` command
127120

128121
When submitting txs to the chain, it's quite convenient to wait for the transaction to be included in the chain, so that you can immediately use the result of the transaction.
@@ -184,6 +177,7 @@ will show you all the available facts you can query.
184177

185178
Depending on your role you can access the different manuals.
186179

187-
- [Test-runs Requester manual](docs/requester-role.md)
188-
- [Oracle manual](docs/oracle-role.md)
189-
- [Antithesis Agent manual](docs/antithesis-agent-role.md)
180+
- [Requester manual](docs/requester-role.md). A test-run requester is the regular user of the system. They can register users and roles, and request test-runs.
181+
- [Agent manual](docs/antithesis-agent-role.md). This is a special role that holds the key to the Antithesis platform. It is responsible for
182+
whitelisting repository and managing test-runs, from pending state to running and completed.
183+
- [Oracle manual](docs/oracle-role.md). The oracle is the owner of the Antithesis token. It is almost mechanically responsible for merging change requests from the agent and the requester.

0 commit comments

Comments
 (0)