Skip to content

Commit

Permalink
beeflow core info (#908)
Browse files Browse the repository at this point in the history
* Add a way to get information about the current bee instance (work directory location, version and logs location)
  • Loading branch information
aquan9 authored Sep 4, 2024
1 parent 4f58baa commit 2259f41
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
9 changes: 9 additions & 0 deletions beeflow/client/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,15 @@ def status():
print(f'{comp} ... {stat}')


@app.command()
def info():
"""Get information about beeflow's installation."""
version = importlib.metadata.version("hpc-beeflow")
print(f"Beeflow version: {version}")
print(f"bee_workflow directory: {paths.workdir()}")
print(f"Log path: {paths.log_path()}")


@app.command()
def stop(query='yes'):
"""Stop the current running beeflow daemon."""
Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Options:

``beeflow core status``: Check the status of beeflow and the components.

``beeflow core info``: Get information about beeflow, including .beeflow directory location, log location, and version number.

``beeflow core stop``: Stop running beeflow components. Active workflows will be paused. You may continue running paused workflows with the ``beeflow resume <wf_id>`` command. Once you start beeflow components after a stop, you should check the status of workflows, query any running workflows. If they were intializing when a ``beeflow core stop`` was issued, the workflow may be running with tasks stuck in the waiting state. If this occurs and you want the workflow to continue pause and resume the workflow (``beeflow pause <wf_id>``, ``beeflow resume <wf_id>``) or to start over cancel the workflow (``beeflow cancel <wf_id>``) and resubmit it.

``beeflow core --version``: Display the version number of BEE.
Expand Down

0 comments on commit 2259f41

Please sign in to comment.