CLI app for developers prototyping atproto functionality
Improve README
+34
-14
+34
-14
README.md
+34
-14
README.md
···
1
1
# atproto-devtool
2
2
3
-
A developer tool for the [atproto](https://atproto.com/) ecosystem. The first
4
-
command it ships with is `test labeler`, which runs a conformance suite against
5
-
an atproto labeler and reports pass/fail results for identity resolution, HTTP
6
-
endpoints, the subscription firehose, and label signature cryptography.
3
+
A multitool for the [atproto](https://atproto.com/) developer ecosystem.
7
4
8
5
## Installation
9
6
10
-
From a checkout of this repository:
7
+
| Environment | CLI command |
8
+
|-------------|-------------|
9
+
| Cargo (Rust 1.85+) | `cargo install --path .` |
11
10
12
-
```bash
13
-
cargo install --path .
14
-
```
11
+
## Usage
15
12
16
-
## `test labeler`
13
+
### `test labeler`
17
14
18
-
Run the labeler conformance suite against a labeler. The suite runs four stages
19
-
in order — identity, HTTP, subscription, and crypto — and produces a structured
20
-
report with per-check results plus a summary exit code.
15
+
Runs a conformance suite against a labeler, and produces a structured report
16
+
with per-check results plus a summary exit code. The suite has four stages:
17
+
18
+
- **Identity**: DID document contains the correct entries, and the labeler's PDS
19
+
holds a valid labeler record.
20
+
- **HTTP**: Checks the `com.atproto.label.queryLabels` XRPC API.
21
+
- **Subscription**: Checks the `com.atproto.label.subscribeLabels` WebSocket.
22
+
- **Crypto**: Samples labels and verifies their signatures.
21
23
22
24
```text
23
25
Run the labeler conformance suite against an atproto labeler
···
50
52
Print help (see a summary with '-h')
51
53
```
52
54
53
-
### Examples
55
+
#### Examples
54
56
55
57
Resolve by handle:
56
58
···
76
78
fetches, per-label verification). `NO_COLOR=1` or `--no-color` disables ANSI
77
79
escape sequences in the rendered report.
78
80
79
-
### Exit codes
81
+
#### Exit codes
80
82
81
83
- `0` — all spec-required checks passed (advisories and skipped checks are
82
84
allowed).
83
85
- `1` — one or more spec-required checks failed.
86
+
- `2` — no spec-required checks failed but one or more network errors occurred.
87
+
88
+
## License
89
+
90
+
Licensed under either of
91
+
92
+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
93
+
http://www.apache.org/licenses/LICENSE-2.0)
94
+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
95
+
96
+
at your option.
97
+
98
+
### Contribution
99
+
100
+
Unless you explicitly state otherwise, any contribution intentionally
101
+
submitted for inclusion in the work by you, as defined in the Apache-2.0
102
+
license, shall be dual licensed as above, without any additional terms or
103
+
conditions.