this repo has no description
Readme
+48
+48
README.md
+48
README.md
···
1
+
<p align="center">
2
+
<img src="https://github.com/skyware-js/.github/blob/main/assets/logo-dark.png?raw=true" height="72">
3
+
</p>
4
+
<h1 align="center">@skyware/labeler</h1>
5
+
6
+
A lightweight alternative to Ozone for operating an atproto labeler.
7
+
8
+
[Documentation](https://skyware.js.org/docs/firehose)
9
+
10
+
## CLI
11
+
12
+
The `@skyware/labeler` package also comes with a CLI for setting up and managing a labeler.
13
+
14
+
```sh
15
+
$ npx @skyware/labeler
16
+
Usage: npx @skyware/labeler [command]
17
+
Commands:
18
+
setup - Initialize an account as a labeler.
19
+
clear - Restore a labeler account to normal.
20
+
label add - Add new label declarations to a labeler account.
21
+
label delete - Remove label declarations from a labeler account.
22
+
```
23
+
24
+
For a full guide to setting up a labeler, see [Getting Started](https://skyware.js.org/guides/labeler/introduction/getting-started).
25
+
26
+
## Installation
27
+
28
+
```sh
29
+
npm install @skyware/labeler
30
+
```
31
+
32
+
## Example Usage
33
+
34
+
This library requires an existing labeler declaration. To get set up, refer to the [Getting Started](https://skyware.js.org/guides/labeler/introduction/getting-started) guide.
35
+
36
+
```js
37
+
import { LabelerServer } from "@skyware/labeler";
38
+
39
+
const server = new LabelerServer({ did: "···", signingKey: "···" });
40
+
41
+
server.start(14831, (error, address) => {
42
+
if (error) {
43
+
console.error(error);
44
+
} else {
45
+
console.log(`Labeler server listening on ${address}`);
46
+
}
47
+
});
48
+
```