Skip to main content

Installing juneau-terminal

From Juneau 10.0.0, juneau-terminal ships outside Maven too. Each channel carries the files the Juneau PMC voted on with the release, published unchanged after the vote, at the same version as Juneau.

ChannelInstallGives
PyPIuv tool install apache-juneau-terminal or pipx install apache-juneau-terminalThe juneau-terminal command, the toolkit, the pytest plugin and the Playwright reporter.
ZipappDownload apache-juneau-terminal-<v>.pyz from the download page and run it with python3The same command in one file.
Homebrewbrew install apache/juneau/juneau-terminalThe command only.
npmnpm i -D @apache/juneau-terminal-playwrightThe Playwright reporter.

The command needs Python 3.10 or later and a POSIX system (macOS or Linux). Without installing anything, uvx --from apache-juneau-terminal juneau-terminal --version runs it once.

The command​

juneau-terminal run maven -- mvn -q test # one tool as one terminal-protocol step
juneau-terminal watch -d . -t push -- python3 scripts/push.py "message" # the same in a watchable tmux pane
juneau-terminal pane list # the pane helper itself
juneau-terminal path bin watch-run.sh # the path of a packaged script
juneau-terminal path reporter # the Playwright reporter file
juneau-terminal path plugin # the directory holding the pytest plugin
juneau-terminal --version # package and terminal-protocol versions

watch and pane run the tmux helpers described in Watching a Run from an AI Agent. They need tmux, bash, ps, pgrep and perl, and exit 2 outside tmux; use run there. The .pyz takes the same arguments, and also answers --bin NAME as the Maven toolkit zip does.

pytest​

Installed from PyPI, the pytest plugin is registered with pytest, but it stays silent unless a run asks for it, so a plain pytest looks as it did before:

pytest -p juneau_terminal_pytest # or PYTEST_ADDOPTS="-p juneau_terminal_pytest"
JUNEAU_TERMINAL_PYTEST_STREAM=1 pytest

juneau-terminal run pytest -- pytest asks for it itself.

Playwright​

juneau-terminal run playwright -- npx playwright test adds the reporter on its own. To name it in playwright.config instead, install the npm package and add it to the reporters:

reporter: [["list"], ["@apache/juneau-terminal-playwright"]],

When both are present in one run, only one copy reports.

Maven​

The org.apache.juneau:juneau-terminal:<version> artifacts (:py, :zip and :py:pytest) are unchanged, and a repository that loads the toolkit through Maven or a vendored bootstrap.py keeps working as before.