Setup

Setup

You can run bee from any folder. However, it's recommended to run bee new while being in a project folder to create a Beefile. The Beefile contains necessary configuration like project name, bee version and which plugins should be enabled. Some plugins may require additional configuration, please update your Beefile accordingly.

cd MyProject
bee new

Open Beefile in a text editor and specify the project name and plugins you'd like to use.

BEE_PROJECT=MyProject

# BEE_VERSION is optional.
# If not assigned, it will use the bee version installed on your system.
# Use BEE_VERSION to keep using a specific version for backwards compatibility.
BEE_VERSION=1.0.0

# Specify which plugins you'd like to use
BEE_PLUGINS=(
  github
  semver
)

For a complete list of all available plugins run:

bee pull
bee hubs

Run bee install to install all specified plugins into ~/.bee/caches/plugins

bee install

Some plugins require specific variables to be set in order to work properly. Run bee <plugin> without arguments to print the plugin help.

bee semver

This will print the plugin help. See the template section for required variables and copy them into your Beefile. Variables marked with # default are optional and will have a default value.

BEE_PROJECT=MyProject
BEE_VERSION=1.0.0
BEE_PLUGINS=(
  github
  semver
)

GITHUB_ORG="org"
GITHUB_ORG_ID="0123456789"
GITHUB_REPO="${GITHUB_ORG}/${BEE_PROJECT}"

# GITHUB_TOKEN is a secret and should not be commited in plain text.
# Implement a safe way how to retrieve the value,
# e.g. read from keychain
# Can also be set as an env variable,
# e.g. when using GitHub actions and GitHub secrets
GITHUB_TOKEN="$(secrets GITHUB_TOKEN)"

You can implement a special function called bee::secrets to delay setting secrets until a plugin is loaded and about to run.

bee::secrets() {
  GITHUB_TOKEN="$(secrets GITHUB_TOKEN)"
}

Some plugins require additional resources. Run bee res <plugin> to copy resource files to BEE_RESOURCES (default: .bee).

bee res ios

See the BEE_RESOURCES folder and make changes to the files if needed.

You're all set now and you can start running commands!

bee semver write 0.1.0