libervia-backend: doc/libervia-cli/shell.rst annotate

annotate doc/libervia-cli/shell.rst @ 4074:26b7ed2817da

refactoring: rename `sat_frontends` to `libervia.frontends`

author	Goffi <goffi@goffi.org>
date	Fri, 02 Jun 2023 14:12:38 +0200
parents	267e4987b58b
children

rev	line source
3563 267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	1 =============================
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	2 shell: use Libervia with REPL
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	3 =============================
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	4
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	5 ``shell`` launch a read–eval–print loop (REPL) with some helpers to launch li commands.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	6 This is useful if you are willing to a session when you'll use several commands in a row
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	7 (for e.g. to inspect something on a PubSub service).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	8
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	9 start the shell
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	10 ===============
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	11
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	12 To start the shell, you just have to enter ``li shell``. You can eventually specify a
c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	13 profile to use an other one than the default one by entering ``li shell -p
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	14 <some_profile>``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	15
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	16
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	17 .. _libervia-cli_shell_use:
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	18
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	19 use the shell
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	20 =============
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	21
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	22 Once in the shell, you can launch a command by entering it as usual (without having to
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	23 specify ``li``). For instance to get last 2 blog posts from your personal blog, you just
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	24 have to enter::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	25
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	26 > blog get -m 2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	27
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	28 There are 2 kinds of commands in the shell:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	29
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	30 - shell commands which are command to manipulate the shell itself
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	31 - li commands which are the classic commands that you use with li
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	32
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	33 The most important thing to remember is that you can use ``?`` (or ``help`` which is
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	34 equivalent) to get the list of commands (shell + li), and ``?<command>`` (or ``help
c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	35 <command>``) to get information on a shell command. For li commands, you can use the usual
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	36 ``--help`` argument.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	37
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	38 You may move in the commands hierarchy using ``cmd`` which can be seen as something
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	39 roughly equivalent to ``cd`` for the filesystem. for instance if you know you'll work with
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	40 XMPP blogs, you can enter::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	41
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	42 > cmd blog
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	43
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	44 Then you'll be in the blog hierarchy, you can check that by entering ``?``. From there you
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	45 can use blog commands directly, like in this example to retrieve last 2 blog posts::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	46
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	47 blog> get -m 2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	48
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	49 You can even go further, e.g. if you know that you'll do several ``get`` command (in this
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	50 can you'll only have to specify the arguments of ``get``)::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	51
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	52 blob> cmd get
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	53 blog/get> -m 2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	54
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	55 You can use ``/`` with ``cmd``, including as first character to indicate that you want to
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	56 start from root::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	57
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	58 blog/get> cmd /pubsub
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	59 pubsub> cmd node/info
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	60
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	61 Similarly, you can use ``..`` to move to parent command::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	62
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	63 pubsub/node/info> cmd ..
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	64
3092 9464ad3b2ece doc (jp/shell): typos Goffi <goffi@goffi.org> parents: 3041 diff changeset	65 One of the interesting feature of shell is that you can fix an argument, i.e. indicate
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	66 the value to use in the next commands. For instance if you're willing to work on a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	67 specific node, you can set its value with ``use``::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	68
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	69 blog> use node some_interesting_node
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	70
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	71 Then you won't have to specify it anymore for each command. The name of the argument to
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	72 fix must be the long form. To check which arguments are fixed, just enter ``use`` without
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	73 argument. If an argument is fixed but not used in a command, it will be ignored.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	74
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	75 To clear a fixed argument, you have the ``use_clear`` command. To clear the ``node``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	76 argument set above, just enter::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	77
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	78 blog> use_clear node
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	79
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	80 Without argument, all fixed arguments will be cleared.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	81
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	82
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	83 Shell commands
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	84 ==============
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	85
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	86 Below is a description of shell commands.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	87
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	88
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	89 cmd
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	90 ---
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	91
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	92 Move in the command hierarchy, this avoid to type again a command if you know you'll use
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	93 it several times. See libervia-cli_shell_use_ for explanation and examples
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	94
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	95 do
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	96 --
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	97
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	98 Launch a li command. By default the command is launched if you enter directly its name and
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	99 arguments, but if a command or argument conflict with a shell command, the shell command
3092 9464ad3b2ece doc (jp/shell): typos Goffi <goffi@goffi.org> parents: 3041 diff changeset	100 will be launched instead. The ``do`` command avoid such a situation by always launching a
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	101 li command::
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	102
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	103 > do blog get -m 2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	104
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	105 exit
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	106 ----
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	107
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	108 Quit the shell (alias of ``quit``).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	109
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	110 help (alias ``?``)
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	111 ------------------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	112
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	113 Give information on available commands or on a specific command, see libervia-cli_shell_use_ for
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	114 more explanations.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	115
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	116 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	117 ^^^^^^^^
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	118
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	119 Get general help::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	120
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	121 > ?
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	122
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	123 Get help on ``do`` command::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	124
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	125 > ?do
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	126
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	127 quit
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	128 ----
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	129
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	130 Quit the shell
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	131
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	132 shell (alias ``!``)
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	133 -------------------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	134
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	135 Launch an external command.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	136
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	137 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	138 ^^^^^^^
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	139
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	140 Print a calendar with ``cal``::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	141
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	142 > !cal
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	143
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	144 use
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	145 ---
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	146
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	147 Fix the value of an argument, which will then be set for all following commands, see
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	148 libervia-cli_shell_use_ for more explanations.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	149
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	150 Without argument, show all fixed arguments
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	151
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	152 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	153 ^^^^^^^^
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	154
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	155 Fix the PubSub node (the long name of the argument is used, so it will go to ``--node``)::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	156
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	157 pubsub> use node some_intersting_node
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	158
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	159 Show all fixed arguments::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	160
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	161 > use
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	162
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	163 use_clear
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	164 ---------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	165
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	166 Unfix the value of an argument (i.e. use the normal default value). Without argument,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	167 it unfixes all arguments.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	168
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	169 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	170 ^^^^^^^^
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	171 Clear the node::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	172
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	173 pubsub> use_clear node
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	174
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	175 Clear all arguments::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	176
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	177 > use_clear
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	178
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	179 verbose
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	180 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	181
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	182 Without argument, show if verbose mode is activated. With an argument evaluating to a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	183 boolean, activate or deactivate this mode.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	184
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	185 In verbose mode, the fixed arguments and the command launched are printed before launching
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3092 diff changeset	186 a li command.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	187
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	188 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	189 ^^^^^^^^
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	190
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	191 Show if verbose mode is activated::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	192
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	193 > verbose
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	194
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	195 Activate verbose mode::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	196
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	197 > verbose on
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	198
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	199 version
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	200 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	201
3505 4705f80b6e23 doc: more renaming Goffi <goffi@goffi.org> parents: 3488 diff changeset	202 Print current version of li/Libervia.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	203
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	204 whoami
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	205 ------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	206
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	207 Show the name of the connected profile (the one set with ``--profile`` when launching the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	208 shell). This profile will be used as default profile.

Mercurial > libervia-backend

annotate doc/libervia-cli/shell.rst @ 4074:26b7ed2817da