http://hg.omfa.de/prosody-hg/ en-us util/prosodyctl/shell.lua revision history http://hg.omfa.de/prosody-hg/log/3c2bfa6a69df/util/prosodyctl/shell.lua
We're figuring out how to keep usability and support machine-readability too.

We moved the status line (repl-result) to stderr so that when parsing
something like a table, it didn't get in the way. However sometimes the status
line is the thing we want to parse (e.g. invite creation). Parsing stderr
loses one of the purposes of stderr - to have an error-only channel to emit
stuff out of band (such as error messages).

So the new approach is:

- Status line on stdout, unless it's an error
- If you're parsing the output ("content") of the command, pass --quiet to
suppress the status line.]]> Matthew Wild <mwild1@gmail.com> Tue, 30 Dec 2025 16:30:43 +0000 http://hg.omfa.de/prosody-hg/log/1df1782ccdfe/util/prosodyctl/shell.lua
This fixes a bug introduced in 3326c8a29a86 where prosodyctl shell would
always exit with non-zero error codes, even on success. Now it will exit with
0 for success, or 1 if any errors were printed.

It also updates the other exit codes in the shell command to help distinguish
between different error cases. These are based on the sysexits.h codes,
although it is not recommended to rely on that interface.]]> Matthew Wild <mwild1@gmail.com> Fri, 19 Dec 2025 15:32:26 +0000 http://hg.omfa.de/prosody-hg/log/3326c8a29a86/util/prosodyctl/shell.lua
When output is piped somewhere and tables are formatted as TSV, it
complicates parsing to have a non-TSV line at the end.]]> Kim Alvefur <zash@zash.se> Mon, 06 Oct 2025 00:30:14 +0200 http://hg.omfa.de/prosody-hg/log/b1e7d3f571b1/util/prosodyctl/shell.lua
This is meant to make it easier to use in scripts.

CSV would have been nice but requires escaping of fields containing ",",
but this implementation simply ignores this and assumes fields will not
contain tabs.]]> Kim Alvefur <zash@zash.se> Sun, 31 Aug 2025 00:47:25 +0200 http://hg.omfa.de/prosody-hg/log/c8e534b4f2e2/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Mon, 31 Mar 2025 17:30:50 +0100 http://hg.omfa.de/prosody-hg/log/a28349b8a387/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Thu, 13 Mar 2025 11:37:11 +0000 http://hg.omfa.de/prosody-hg/log/1465b1e305df/util/prosodyctl/shell.lua
This allow a shell-command to provide a 'flags' field, which will automatically
cause the parameters to be fed through argparse.

The rationale is to make it easier for more complex commands to be invoked
from the command line (`prosodyctl shell foo bar ...`). Until now they were
limited to accepting a list of strings, and any complex argument processing
was non-standard and awkward to implement.]]> Matthew Wild <mwild1@gmail.com> Mon, 17 Feb 2025 17:02:35 +0000 http://hg.omfa.de/prosody-hg/log/e5f62871e6a5/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Thu, 06 Feb 2025 14:23:15 +0000 http://hg.omfa.de/prosody-hg/log/ca9426f98b8e/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Wed, 08 Jan 2025 08:53:43 +0100 http://hg.omfa.de/prosody-hg/log/d66f30855822/util/prosodyctl/shell.lua
This lets the server signal to the client that a special input is requested.
Currently we support the "password" type only.]]> Matthew Wild <mwild1@gmail.com> Tue, 07 Jan 2025 18:10:59 +0000 http://hg.omfa.de/prosody-hg/log/7b070909bd15/util/prosodyctl/shell.lua
The code correctly inserted the ',' when there was already a "%q" in the
format string, but then the next argument would fail to match because it
inserted ", %q" instead of "%q". The code now matches both, ensuring the
generated code will not produce a syntax error with multiple arguments.]]> Matthew Wild <mwild1@gmail.com> Wed, 24 Apr 2024 11:45:37 +0100 http://hg.omfa.de/prosody-hg/log/4ba11c2b915a/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Sat, 09 Dec 2023 17:00:22 +0100 http://hg.omfa.de/prosody-hg/log/16413bc29361/util/prosodyctl/shell.lua
e.g.
prosodyctl shell muc room room@muc.example.com :set_name "This Room"]]> Kim Alvefur <zash@zash.se> Sat, 09 Dec 2023 16:25:04 +0100 http://hg.omfa.de/prosody-hg/log/585bd71a1a97/util/prosodyctl/shell.lua
E.g. when you do 'prosodyctl shell "s2s:show()"', this is the case that
triggers, and it was missing the @width argument, causing confusion.]]> Kim Alvefur <zash@zash.se> Fri, 07 Apr 2023 13:58:39 +0200 http://hg.omfa.de/prosody-hg/log/4ae759490e31/util/prosodyctl/shell.lua
Fixes invalid attribute value: expected string, got number]]> Kim Alvefur <zash@zash.se> Fri, 07 Apr 2023 13:53:40 +0200 http://hg.omfa.de/prosody-hg/log/d939bf469057/util/prosodyctl/shell.lua
Feels like it should be faster.]]> Kim Alvefur <zash@zash.se> Fri, 07 Apr 2023 13:42:20 +0200 http://hg.omfa.de/prosody-hg/log/4c3dc767fb11/util/prosodyctl/shell.lua
Kicks in if/when readline hasn't set $COLUMNS, e.g. when using the
`prosodyctl shell command like this` form.]]> Kim Alvefur <zash@zash.se> Fri, 07 Apr 2023 13:38:59 +0200 http://hg.omfa.de/prosody-hg/log/d10957394a3c/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Fri, 17 Mar 2023 16:23:16 +0100 http://hg.omfa.de/prosody-hg/log/9f9633364044/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Sun, 22 Jan 2023 15:43:44 +0100 http://hg.omfa.de/prosody-hg/log/3dfb87814d65/util/prosodyctl/shell.lua
This ensures a last round of garbage collection and finalizers, which
should include flushing the readline history file.

Test procedure:
```
$ ./prosodyctl shell
prosody> s2s:show() -- any command that is not the last in history
... output
prosody> bye
$ ./prosodyctl shell
prosody> ^P
```

After this, the shell prompt should contain the last command from before
the "bye". Before this patch, recent history is gone most of the time.]]> Kim Alvefur <zash@zash.se> Sun, 22 Jan 2023 14:42:07 +0100 http://hg.omfa.de/prosody-hg/log/0f4feaf9ca64/util/prosodyctl/shell.lua
Part of #1600]]> Kim Alvefur <zash@zash.se> Sat, 02 Jul 2022 17:31:14 +0200 http://hg.omfa.de/prosody-hg/log/cfdc8cca64d3/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Wed, 01 Jun 2022 13:59:00 +0200 http://hg.omfa.de/prosody-hg/log/7dae6d29b71d/util/prosodyctl/shell.lua
This lets it adjust the width of tables to the actual terminal width.]]> Kim Alvefur <zash@zash.se> Mon, 30 May 2022 15:28:44 +0200 http://hg.omfa.de/prosody-hg/log/bdb9577a4830/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Thu, 17 Mar 2022 10:21:43 +0000 http://hg.omfa.de/prosody-hg/log/98fd531594bd/util/prosodyctl/shell.lua
I miss my custom ANSI-colored greeting!]]> Kim Alvefur <zash@zash.se> Fri, 12 Nov 2021 22:34:04 +0100 http://hg.omfa.de/prosody-hg/log/b9aab1962a2b/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Thu, 11 Nov 2021 13:27:28 +0000 http://hg.omfa.de/prosody-hg/log/5bd38d9197e1/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Sun, 25 Apr 2021 17:32:27 +0200 http://hg.omfa.de/prosody-hg/log/16caf35f031f/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Sun, 25 Apr 2021 17:27:02 +0200 http://hg.omfa.de/prosody-hg/log/0a464a6e88c4/util/prosodyctl/shell.lua
E.g. `prosodyctl shell module reload disco example.com` becomes
equivalent to `prosodyctl shell 'module:reload("disco", "example.com")`.

Won't work for every possible command, but reduces the amount of shell
quoting problems for most common commands.]]> Kim Alvefur <zash@zash.se> Sun, 25 Apr 2021 17:20:58 +0200 http://hg.omfa.de/prosody-hg/log/0a10bb3b129b/util/prosodyctl/shell.lua
Test procedure:

$ prosodyctl shell 'server:version()'

Expect:

> OK: hg:926d53af9a7a

$ prosodyctl shell 'server:version()' 'hello'

Expect:

> Only one command is supported as argument

$ prosodyctl shell 'lorem ipsum'; echo $?

Expect:
> Sorry, I couldn't understand that... console:1: syntax error near 'show'
> 1 (error code)

Thanks Menel for mentioning the feature]]> Kim Alvefur <zash@zash.se> Fri, 05 Mar 2021 13:02:37 +0100 http://hg.omfa.de/prosody-hg/log/fa5a23d7aabc/util/prosodyctl/shell.lua
Looked in the wrong table

Test procedure:

$ prosodyctl shell --quiet

Expect:
Prosody>

(No banner)]]> Kim Alvefur <zash@zash.se> Fri, 05 Mar 2021 12:39:49 +0100 http://hg.omfa.de/prosody-hg/log/a5b8ae066688/util/prosodyctl/shell.lua
Forgot in previous commit]]> Kim Alvefur <zash@zash.se> Wed, 17 Jun 2020 19:39:14 +0200 http://hg.omfa.de/prosody-hg/log/d86f59c31458/util/prosodyctl/shell.lua
While almost identical to the handling in util.startup, this seems more
appropriate. It would also simplify if shell-specific options need to be
handled in the future.]]> Kim Alvefur <zash@zash.se> Wed, 17 Jun 2020 19:36:39 +0200 http://hg.omfa.de/prosody-hg/log/2b015ef8cd06/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Tue, 02 Jun 2020 09:35:07 +0200 http://hg.omfa.de/prosody-hg/log/09674bbb833f/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Tue, 02 Jun 2020 08:28:39 +0100 http://hg.omfa.de/prosody-hg/log/98c535531450/util/prosodyctl/shell.lua
Forgot it stops parsing --foo options at the first argument, so
subsequent commands need to parse their own options like this.]]> Kim Alvefur <zash@zash.se> Tue, 02 Jun 2020 09:19:07 +0200 http://hg.omfa.de/prosody-hg/log/813e632431e6/util/prosodyctl/shell.lua Kim Alvefur <zash@zash.se> Tue, 02 Jun 2020 09:07:29 +0200 http://hg.omfa.de/prosody-hg/log/e5dee71d0ebb/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Tue, 02 Jun 2020 08:01:21 +0100 http://hg.omfa.de/prosody-hg/log/c91697b81349/util/prosodyctl/shell.lua
E.g. `prosodyctl shell --socket /path/to/prosody.scok`]]> Kim Alvefur <zash@zash.se> Mon, 01 Jun 2020 23:57:50 +0200 http://hg.omfa.de/prosody-hg/log/fa06cf7059cd/util/prosodyctl/shell.lua
So now if you set it to a custom value, both the client and the server
should use it.]]> Kim Alvefur <zash@zash.se> Mon, 01 Jun 2020 23:53:03 +0200 http://hg.omfa.de/prosody-hg/log/561138169983/util/prosodyctl/shell.lua
Don't hardcode socket path as it happens to be in a source checkout.

Hold on, it should use the same config option as the module!]]> Kim Alvefur <zash@zash.se> Mon, 01 Jun 2020 23:26:30 +0200 http://hg.omfa.de/prosody-hg/log/8de0057b4279/util/prosodyctl/shell.lua
Fixes the client pausing for input after output from commands.]]> Matthew Wild <mwild1@gmail.com> Mon, 01 Jun 2020 16:14:06 +0100 http://hg.omfa.de/prosody-hg/log/efa49d484560/util/prosodyctl/shell.lua Matthew Wild <mwild1@gmail.com> Mon, 01 Jun 2020 15:44:44 +0100