Skip to content

docs: Mention need for stomp config in run subcommand #1515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tpoliaw wants to merge 3 commits into
base: main
Choose a base branch
from
+6 −1
Open

docs: Mention need for stomp config in run subcommand #1515

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b96fd3
docs: Mention need for stomp config in run subcommand
tpoliaw Apr 24, 2026
5a09116
Use correct quotes
tpoliaw Apr 24, 2026
06bf854
del to
tpoliaw Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/blueapi/cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,12 @@ def run_plan(
instrument_session: str,
parameters: TaskParameters,
) -> None:
"""Run a plan with parameters"""
"""Run a plan with parameters

To run in the foreground and block until it is complete, stomp
configuration is required. Without stomp configuration, '--bg' can be used
to start a plan in the background.
"""

client = cast(BlueapiClient, obj["client"])
task = TaskRequest(
Expand Down
Loading