README.md

FluxQueue CLI

A command-line tool for installing and running FluxQueue workers.

Installation

pip install fluxqueue-cli

Installing the Worker

Use the CLI to install the worker on your system:

fluxqueue worker install

You can also install it in a custom path:

fluxqueue worker install --path .fluxqueue/

Starting a Worker

To start a worker, provide the path to the module where your tasks are exported:

fluxqueue start --tasks-module-path src/tasks

To start the worker installed at the custom path you can do the following, add these lines in your pyproject.toml:

[tool.fluxqueue_cli]
worker_path = ".fluxqueue/fluxqueue-worker"

Then running the command above will run that worker by default.

Documentation

For more information and documenation about the usage please visit FluxQueue Documentation.

License

FluxQueue is licensed under the Apache-2.0 license. See LICENSE for details.