Deworker CLI

Welcome to use deworker cli. This is a cli for deworker protocol powered by questflow labs.

Installation

Windows maybe not work, you can use WSL, linux or mac.

Prerequisites

Before you install deworker cli, you need to have node.js(>= v18.x) installed on your machine. You can download it from node.js.

Because we use typescript as the development language, you need to have tsx installed on your machine. You can install it by running:

# pnpm
pnpm install -g tsx

# npm
npm install -g tsx

# yarn
yarn global add tsx

After you have installed all the prerequisites, you can install deworker cli by running:

# pnpm
pnpm install -g @deworker/deworker-cli

# npm
npm install -g @deworker/deworker-cli

# yarn
yarn global add @deworker/deworker-cli

Setup

To setup deworker cli, you need to run the following command:

Setup API key

Now, you can not get API key. Please contact us [email protected] to get one.

deworker config set key your_api_key

Start a worker

Before you start a worker, you need to download a worker from the deworker repositories.

Example

We can clone the hello worker from the deworker repositories by running:

git clone https://github.com/deworkerai/deworker-worker.git hello-worker

Install the dependencies by running:

Go to the worker directory and install the dependencies by running:

cd hello-worker
pnpm install

Register peer

Every worker needs to register a peer before it can start working. You can register a peer by running:

# generate a peer key pair
deworker peer generate --file

If it works, you will see the following output:

generating a peer key...
peer key generated successfuly!
saved peer key into /home/carney/work/questflow/github/hello-worker/peerKey.json successfuly!

And the peerKey.json content like this:

{
  "id": "12D3KooWRLirPVvV5JRHG9YGX7LYcH726WGkBBCUcBvfKGWUZ237",
  "privKey": "CAESQDIwoCcqRVweMwZnHal1W1Hj3XLMrHUHNqv4WrZSLDSJ5qYddzhIGiY23T4kuR5RLxoU6v0aRu6XGwlN6don+S4=",
  "pubKey": "CAESIOamHXc4SBomNt0+JLkeUS8aFOr9GkbulxsJTenaJ/ku"
}

Copy the id, we will use it later.

Now you can register your peer bind to this worker by running:

deworker peer register --workerId=worker_id --peerId=your_peer_id

workerId is the worker id you will start get from the deworker.yaml. For the hello worker, the worker id is worker-01

peerId is the peer id you have registered. Here is 12D3KooWRLirPVvV5JRHG9YGX7LYcH726WGkBBCUcBvfKGWUZ237

So, the final command is:

deworker peer register --workerId=worker-01 --peerId=12D3KooWRLirPVvV5JRHG9YGX7LYcH726WGkBBCUcBvfKGWUZ237

If it works, you will see the following output:

registering peer...
the peer has been successfully registered!
peer id: 12D3KooWRLirPVvV5JRHG9YGX7LYcH726WGkBBCUcBvfKGWUZ237
worker id: worker-01

Start the worker

After you have registered the peer, you can start the worker by running:

deworker peer start

If it works, you will see the following output:

checking whether the entry file exist...
choosing a best one relay node address...
executing post hooks...
peer started with id 12D3KooWCoQzkraAg74ghdGhtqqU65zJeWpKonSC3WRRwEquEpMJ
12D3KooWA7xupjkFvhh7FgvASrTPXGzRsrN4yUWoKYw7nmZaQRJM connected
start peer successfully

Congratulations! You have started a worker successfully!