Bee Factory

CLI tool to spin up Docker cluster of Bee nodes for advanced testing and/or development

Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.

Table of Contents

• Install
• Usage
• Contribute
• License

Install

Requirements: Docker

$ npm install -g @ethersphere/bee-factory

Usage

# This spin up the cluster and exits
$ bee-factory start --detach 1.2.0 1.5.1-d0a77598-stateful

# This attaches to the Queen container and displays its logs
$ bee-factory logs queen

# This stops the cluster and keeping the containers so next time they are spinned up the data are kept
# but data are not persisted across version's bump!
$ bee-factory stop

# You can also spin up the cluster without the --detach which then directly
# attaches to the Queen logs and the cluster is terminated upon SIGINT (Ctrl+C)
$ bee-factory start 1.2.0 1.5.1-d0a77598-stateful

For more details see the --help page of the CLI and its commands.

Contribute

There are some ways you can make this module better:

• Consult our open issues and take on one of them
• Help our tests reach 100% coverage!
• Join us in our Discord chat in the #develop-on-swarm channel if you have questions or want to give feedback

Developing

You can run the CLI while developing using npm start -- <command> ....

Maintainers

• auhau
• Cafe137

License

BSD-3-Clause