YunoHost/yunohost
1
0
Fork 0
mirror of https://github.com/YunoHost/yunohost.git synced 2024-09-03 20:06:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

Improve ynh_spawn_app_shell documentation

Browse source
This commit is contained in:
tituspijean 2023-05-24 22:32:51 +00:00
parent cacd43e147
commit bb9db08e29
No known key found for this signature in database
GPG key ID: EF3B0D7CC0A94720
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
helpers/apps
View file

@ -112,16 +112,19 @@ ynh_remove_apps() {
fi fi
} }
# Load an app environment in the current Bash shell # Spawn a Bash shell with the app environment loaded
# #
# usage: ynh_install_apps --app="app" # usage: ynh_spawn_app_shell --app="app"
# | arg: -a, --app= - the app ID # | arg: -a, --app= - the app ID
# #
# examples: # examples:
# ynh_spawn_app_shell --app="APP" <<< 'echo "$USER"' # ynh_spawn_app_shell --app="APP" <<< 'echo "$USER"'
# ynh_spawn_app_shell --app="APP" < /tmp/some_script.bash # ynh_spawn_app_shell --app="APP" < /tmp/some_script.bash
# #
# Requires YunoHost version 11.0.* or higher. # Requires YunoHost version 11.0.* or higher, and that the app relies on packaging v2 or higher.
# The spawned shell will have environment variables loaded and environment files sourced
# from the app's service configuration file (defaults to $app.service, overridable by the packager with `service` setting).
# If the app relies on a specific PHP version, then `php` will be aliased that version.
ynh_spawn_app_shell() { ynh_spawn_app_shell() {
# Declare an array to define the options of this helper. # Declare an array to define the options of this helper.
local legacy_args=a local legacy_args=a