https://github.com/skyware-js/labeler
A lightweight alternative to Ozone for operating an atproto labeler.
https://github.com/skyware-js/labeler
Last synced: 5 days ago
JSON representation
A lightweight alternative to Ozone for operating an atproto labeler.
- Host: GitHub
- URL: https://github.com/skyware-js/labeler
- Owner: skyware-js
- License: mpl-2.0
- Created: 2024-08-22T19:19:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-23T20:25:03.000Z (3 months ago)
- Last Synced: 2025-02-07T05:11:30.579Z (15 days ago)
- Language: TypeScript
- Size: 95.7 KB
- Stars: 44
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@skyware/labeler
A lightweight alternative to Ozone for operating an atproto labeler.
[Documentation](https://skyware.js.org/docs/firehose)
## CLI
The `@skyware/labeler` package also comes with a CLI for setting up and managing a labeler.
```sh
$ npx @skyware/labeler
Usage: npx @skyware/labeler [command]
Commands:
setup - Initialize an account as a labeler.
clear - Restore a labeler account to normal.
recreate - Recreate the labeler declaration (recommended if labels are not showing up).
label add - Add new label declarations to a labeler account.
label delete - Remove label declarations from a labeler account.
label edit - Bulk edit label definitions.
```
For a full guide to setting up a labeler, see [Getting Started](https://skyware.js.org/guides/labeler/introduction/getting-started).
## Installation
```sh
npm install @skyware/labeler
```
## Example Usage
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.
```js
import { LabelerServer } from "@skyware/labeler";
const server = new LabelerServer({ did: "···", signingKey: "···" });
server.start(14831, (error, address) => {
if (error) {
console.error(error);
} else {
console.log(`Labeler server listening on ${address}`);
}
});
```