From eed1d84653a274c32826a5eae4e5de66feb3278a Mon Sep 17 00:00:00 2001 From: Janne Valkealahti Date: Wed, 18 May 2022 09:44:26 +0100 Subject: [PATCH] Update docs --- .../asciidoc/using-shell-components-builtin.adoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/spring-shell-docs/src/main/asciidoc/using-shell-components-builtin.adoc b/spring-shell-docs/src/main/asciidoc/using-shell-components-builtin.adoc index 57b286e8..22bb72f7 100644 --- a/spring-shell-docs/src/main/asciidoc/using-shell-components-builtin.adoc +++ b/spring-shell-docs/src/main/asciidoc/using-shell-components-builtin.adoc @@ -93,6 +93,21 @@ to be comments and are ignored, while lines ending with `\` trigger line continu The `history` command shows history of a commands which has been executed. +There are few configuration options which can be used to configure behaviour +of a history. History is kept in a log file which is enabled by default and can +be turned off using `spring.shell.history.enabled`. Name of a log file +is resolved from `spring.application.name` and defaults to _spring-shell.log_ +which can be changed using `spring.shell.history.name`. + +On default a log file is generated to a current working directory which can be +changed using `spring.shell.config.location`. This property can contain +a placeholder _{userconfig}_ which resolves to a common shared config directory. + +[TIP] +==== +Check how sample app works as it's using these options. +==== + ===== Completion The `completion` command set allows you to create _scripts_ files which can be used