Please make sure that the feature you are suggesting is reported in the right place. Documentation, Dashboard etc all have their own repos. Suggestion for new features should be posted there.

Describe the solution you'd like
I would like to configure the ouri if the exist-context was changed from /exist to / similar to -ouri=xmldb:exist://192.168.1.2:80/xmlrpc

Describe alternatives you've considered
n/a

Additional context
Changed context for exist from /exist to /

xst packages list [options]

Aliases:

• ls

Should return tabulated list of package-abbreviations.

Example Output:

package-service
dashboard
monex
html-templating
eXide

Possible options:

• --versions, -V : list installed version
• --libraries, -l or -L: list only installed libraries
• --applicationts, -a or -A: list only installed applications
• --filter, -f: list only libraries and/or applications that match a given pattern
• --extended, -e: add more information to the result (date of installation, namespace URI, declared dependencies, ...)
• --json, -j: return result as json (in order to pipe it to jq for example or store it in a file)
• --full-name: return namespace URIs instead of abbreviated names

refs eXist-db/node-exist#223

Please make sure that the feature you are suggesting is reported in the right place. Documentation, Dashboard etc all have their own repos. Suggestion for new features should be posted there.

Is your feature request related to a problem? Please describe.
When uploading, the permissions are set from the uploading users permissions. It would be nice to be able to specify a target for permissions of the uploaded files
Describe the solution you'd like
I would like to see a config option that allows setting permissions for the target
Describe alternatives you've considered
I could also run a xquery on the server to fix this, but getting it in one run would be much nicer :-)
Additional context
Not really, but this is a nifty tool!

refs eXist-db/node-exist#241

Enhancement

At the moment xst only allows installation of packages that are locally available. While this is useful for local build artefacts there are plenty of pre-built packages available at the public package repository.

It would be handy if xst would allow to install any of them without having to download them first.

xst package install --from-repo [--repo-url] <packages..>

The XQuery implementation might end up just being a call to repo:install-and-deploy#2 and some error handling wrapped around it.

related to #13 (to query 3rd party repositories)

Alternatives

No response

Enhancement

Some commands, for instance upload, shows the duratoin in the output, for example Created 0 collections and uploaded 1 resources in 292ms.

In the case of execute command, I'm missing this information.

I'm debugging the indexing routine by modifying the indexes and input data. I repeat the same command with different data (collection.xconf, index.xql, input.xml): xst execute "xmldb:reindex('/db/apps/teilex0-publisher/data/playground')" --config admin.xstrc.

Duration of the task is significant for my case.

Alternatives

I run the command using xst and watch the INFO in the eXist-db log.

Enhancement

As a user of the fish shell I would like xst to provide completions not only for zsh and bash but for fish as well.

This will finally be possible when yargs/yargs#2281 is merged.

Alternatives

In the meantime you can already start with this script (ripped from the PR above)

Create a file ~/.config/fish/completions/xst.fish with following contents:

### xst completion - begin. generated by omelette.js ###
#
# yargs command completion script
#
#
function _xst_yargs_completion
  set cmd (commandline -b)
  for arg in (string split " " $cmd)
      set -a args "'$arg'"
  end
  set completions (eval xst --get-yargs-completions $args)
  for completion in $completions
    echo -e $completion
  end
end
complete -f -c xst -a '(_xst_yargs_completion)'
### xst completion - end ###

XAR packages that exceed approximately 500 MB cannot be uploaded.
This is a limitation of the XML-RPC API.

Switching to the REST-API for uploading the resource will fix this.

refs eXist-db/node-exist#243

originally requested by @chakl

xst edit <resource> [options]

Create a new command edit that will

1. download the resource
2. open the application defined in the EDITOR environment variable or given in the --editor option
3. upload the resource when the file is saved inside the editor
4. exit the process when the editor is closed

Examples

xst edit /db/temp/resource.xml

xst edit /db/temp/resource.xml --editor vim

Is your feature request related to a problem? Please describe.

As a database admin I want to quickly update all installed packages.

Describe the solution you'd like

xst package update [--repo] [<packages>..]

packages is a space separated list of identifiers. Identifiers can be either the (abbreviated) name or the namespace URI of the package.

update all

• xst package update

update one

• xst package update monex
• xst package update http://line-o/xq/dicey

use non-default repository for lookups

• xst package update --repo https://localhost:8080/exist/apps/public-repo monex

Describe alternatives you've considered

To avoid having to move xst install to xst package install the command could also just be xst update.

Additional context

This feature request is a result of a slack discussion
A first implementation for the db query

related #33

What happened?

Setting properties "secure" : false, "protocol": "http:" in config file raises an error:

Parse Error: Expected HTTP/

A different combination of properteis ("secure" : false, protocol": "https:") will raise a diffeent error:

Protocol "https:" not supported. Expected "http:"

If use only "protocol": "http:" (withou secure property) following error occurs:

Protocol "http:" not supported. Expected "https:"

System Information

Running xst info --config redaktor.xstrc raises the same errors. Without configuration:

Build: eXist-6.2.0 (c8fa4958b6d4a50bd0cba7f3e76a150226414187)
Java: 11.0.16.1 (Microsoft)
OS: Windows 10 10.0 (amd64)

Relevant shell output

No response

What happened?

If I use xst to upload files to the colletion on eXist-db and the main collection don't exist, the upload fails and the failed steps are described in the verbose log.

But the last line of the output claims that everything went fine: created 1 collections and uploaded 1 resources in 144ms

System Information

Build: eXist-6.0.1 (51506fc97a9e5bb55fdea71fc76def2c9d402886)
Java: 1.8.0_292 (Azul Systems, Inc.)
OS: Windows 10 10.0 (amd64)

Relevant shell output

SET project=mordigital
xst upload -i "*.xml" -v ../local/data/ /db/apps/%project%-data/data/dictionaries --config %project%.xstrc

target exists: false
Uploading: ../local/data/ to /db/apps/mordigital-data/data/dictionaries
Server: https://localhost:8443
User: mordigital
Include:
 *.xml

Uploading directory tree
✘ /db/apps/mordigital-data/data/dictionaries/ could not be created! Reason: Failed to invoke method createCollection in class org.exist.xmlrpc.RpcConnection: No write permissions for /db/apps
✘ morais1_pages 157_159.xml could not be created! Reason: Failed to invoke method parseLocal in class org.exist.xmlrpc.RpcConnection: collection /db/apps/mordigital-data/data/dictionaries not found!
created 1 collections and uploaded 1 resources in 144ms

To be able to better understand you problem, please add as much information as possible to this ticket. Always test your bugs against the latest stable release of exist. We cannot provide support for older versions here on GitHub. If the version of eXist that is experiencing the issue is more than 1 major version behind the most recent release, please consider posting a question on our mailing list.

Describe the bug
I try to download a resource/collection via xst. Unfortunately, I just get the xst splash screen.

Expected behavior
Download of the resource

To Reproduce

The best way is to provide an SSCCE (Short, Self Contained, Correct (Compilable), Example). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. Please locate the existing test-suite and follow the examples provided there:

xst get /db/apps/stephan/ZZUXMPUX.xml . --config dockerhost

where "dockerhost" is the name of my config file. ls of collections works well... so I can confirm that my config file is working

Screenshots
If applicable, add screenshots to help explain your problem.

Context (please always complete the following information):

• OS: Ventura 13.0.1 MacOs
• eXist-db Version: 5.2.0
• App Version: XST build via npm install

Additional context

• How is eXist-db installed? started via bin/startup.sh
• Any custom changes in e.g. conf.xml? Nope

What happened?

After installing xst globally, setting the path to the npm repository (C:\Users\<User>\AppData\Roaming\npm) and running xst from Windows Powershell Command, or a Command Prompt the error Cannot find package 'execa' is thrown.

Xst program will not run.

System Information

Microsoft Windows [Version 10.0.19045.2604]

Relevant shell output

PS C:\Users\<User>> xst --version

node:internal/errors:464
    ErrorCaptureStackTrace(err);
    ^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'execa' imported from C:\Users\<User>\AppData\Roaming\npm\node_modules\@existdb\xst\commands\edit.js
    at new NodeError (node:internal/errors:371:5)
    at packageResolve (node:internal/modules/esm/resolve:884:9)
    at moduleResolve (node:internal/modules/esm/resolve:929:18)
    at defaultResolve (node:internal/modules/esm/resolve:1044:11)
    at ESMLoader.resolve (node:internal/modules/esm/loader:422:30)
    at ESMLoader.getModuleJob (node:internal/modules/esm/loader:222:40)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:40)
    at link (node:internal/modules/esm/module_job:75:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}

What happened?

I have an existing .existdb.json which is configured with user 'admin' and empty pass (for local development) but xst keeps on complaining : "Package installation failed. User "guest" is not a member of the "dba" group."

System Information

Build: eXist-6.2.0 (c8fa4958b6d4a50bd0cba7f3e76a150226414187)
Java: 1.8.0_382 (Azul Systems, Inc.)
OS: Mac OS X 14.2.1 (aarch64)

(should output xst version too). It is:
1.6.1

Relevant shell output

Package installation failed. User "guest" is not a member of the "dba" group.

What happened?

When calling execute command with parameter that expect string, only combination of single quotes inside double quoted text ("... '..' ... " ) works.

The opposit case ('... ".." ... ') doesn't work: double quotes are ommited.

Combination of single quotes inside double quotes is used in the readme help.

System Information

Build: eXist-6.0.1 (51506fc97a9e5bb55fdea71fc76def2c9d402886)
Java: 1.8.0_292 (Azul Systems, Inc.)
OS: Windows 10 10.0 (amd64)

Relevant shell output

xst execute 'xmldb:reindex("/db/apps/%project%-data")' --config admin.xstrc
xmldb:reindex(/db/apps/mordigital-data)

xst execute "xmldb:reindex('/db/apps/%project%-data')" --config admin.xstrc
true

this would be my most-wanted additional feature to give up on gulp-exist which never really flew for me due to always necessary patches to gulpfile.

xst sync <source> <target>

Synchronise the contents of target with source.

• Resources and collections not found in source will be removed in target.
• Resources and collections not found in target will be copied from source.
• Resources that were modified in source will be copied to target.

Options

• --watch: do not close the process after initial sync but watch for changes and re-sync

refs eXist-db/node-exist#207

Currently xst install allows only one package to be installed per call

xst install <package>

This should be enhanced to allow more than one

xst install <package> [packages..]

How about using issue forms?

Which of the below variants of aligning owner and group do you prefer?

Variant A (right-aligned, status quo)

crwxr-xr-x         SYSTEM            dba    0 B  Jan  4 17:05 apps
crwxr-xr-x          admin            dba    0 B  Jan  4 17:09 ├── atom-editor
crwxr-xr-x         SYSTEM            dba    0 B  Jan  4 17:05 ├── dashboard
crwxr-xr-x         SYSTEM            dba    0 B  Jan  4 17:05 ├── doc
crwxrwxr-x          eXide          eXide    0 B  Jan  6 22:35 ├── eXide
crwxr-xr-x         SYSTEM            dba    0 B  Jan  4 17:05 ├── fundocs
crwxrwxr-x          monex          monex    0 B  Jan  6 22:40 ├── monex
crwxrwxr-x packageservice packageservice    0 B  Jan  4 17:05 ├── packageservice
crwxr-xr-x          admin            dba    0 B  Jan  4 18:01 └── test

Variant B (center)

crwxr-xr-x         SYSTEM dba               0 B  Jan  4 17:05 apps
crwxr-xr-x          admin dba               0 B  Jan  4 17:09 ├── atom-editor
crwxr-xr-x         SYSTEM dba               0 B  Jan  4 17:05 ├── dashboard
crwxr-xr-x         SYSTEM dba               0 B  Jan  4 17:05 ├── doc
crwxrwxr-x          eXide eXide             0 B  Jan  6 22:35 ├── eXide
crwxr-xr-x         SYSTEM dba               0 B  Jan  4 17:05 ├── fundocs
crwxrwxr-x          monex monex             0 B  Jan  6 22:40 ├── monex
crwxrwxr-x packageservice packageservice    0 B  Jan  4 17:05 ├── packageservice
crwxr-xr-x          admin dba               0 B  Jan  4 18:01 └── test

Variant C (left-aligned)

crwxr-xr-x SYSTEM         dba               0 B  Jan  4 17:05 apps
crwxr-xr-x admin          dba               0 B  Jan  4 17:09 ├── atom-editor
crwxr-xr-x SYSTEM         dba               0 B  Jan  4 17:05 ├── dashboard
crwxr-xr-x SYSTEM         dba               0 B  Jan  4 17:05 ├── doc
crwxrwxr-x eXide          eXide             0 B  Jan  6 22:35 ├── eXide
crwxr-xr-x SYSTEM         dba               0 B  Jan  4 17:05 ├── fundocs
crwxrwxr-x packageservice packageservice    0 B  Jan  4 17:05 ├── packageservice
crwxr-xr-x admin          dba               0 B  Jan  4 18:01 └── test

Enhancement

1 2

1 2

this is just a test

Alternatives

CGA rules!

What happened?

xst up data/* /db/apps/my-app/data/ --config .xstrc only uploads the first file in the local data directory and not like expected all files.

System Information

Build: eXist-6.2.0 (c8fa4958b6d4a50bd0cba7f3e76a150226414187)
Java: 11.0.18 (Eclipse Adoptium)
OS: Linux 5.15.0-69-generic (amd64)

Relevant shell output

xst up data/* /db/apps/eebo-data/data --config .xstrc

The execa package, needs node >= 16 at runtime

This means we will bump the minimum node version to node 16 in the near future triggering a major version release.

• update readme
• drop node 14 from test matrix
• add node 20 to test matrix

Remove serialisation setting from .xstrc in spec that will only be available with exist 6.1.0 which is not yet released.

refs #50

What happened?

When using "xst package install registry", I mistakenly specified an invalid package name/version combination (there is no version 6.0.1 of "tuttle"). xst reported the failure, but returns exit code 0 which means "success". When using xst from Ansible, a failed package installation would be reported as "success".

$ /usr/local/bin/xst package install registry http://e-editiones.org/tuttle 6.0.1 --registry http://A_VALID_REGISTRY/exist/apps/public-repo/
Connecting to remote DB using an unencrypted channel.
✘ http://e-editiones.org/tuttle > could not be installed 
$ echo $?
0

xst should return non-zero on failed package installation.

System Information

No response

Relevant shell output

No response

Enhancement

I didn't find an example for deleting a list of files using wildcards in the Readme, and maybe it's not implemented yet.

I tried wildcards in the path: xst remove /db/apps/%project%-data/data/dictionaries/*.xml

I also tried -i parameter of the upload command: xst remove -i "*.xml" /db/apps/%project%-data/data/dictionaries/

Both commands failed.

Alternatives

Only the full name of the document being removed worked: xst remove /db/apps/%project%-data/data/dictionaries/pages_157_159.xml

What happened?

When trying to install a package with xst (starting with version 1.9.0) on an instance of exist-db that has

      <init-param>
         <param-name>hidden</param-name>
         <param-value>true</param-value>
      </init-param>

set in etc/webapp/WEB-INF/web.xml, effectively disabling the REST API, package installation fails with

; xst package install spec/fixtures/test-app.xar
Install test-app.xar on https://localhost:8443
Response code 403 (Forbidden)

As it fails to fall back to XMLRPC API. As a workaround one can still force XMLRPC use by providing --rpc to the installation command.

; xst package install spec/fixtures/test-app.xar --rpc

or by setting it in the configuration (only possible in .xstrc):

{ "rpc": true }

System Information

Build: eXist-7.0.0-SNAPSHOT (b032a424e9e92582938080d90b057a14c079df04)
Java: 17.0.6 (Azul Systems, Inc.)
OS: Mac OS X 13.6 (aarch64)

Relevant shell output

; xst package install spec/fixtures/test-app.xar
Install test-app.xar on https://localhost:8443
Response code 403 (Forbidden)

Enhancement

This might be handy for instances who do not have access to any package repository.
xst would act as a proxy, fetching the package then uploading and installing it in the instance that is connected.

Alternatives

Not doing implementing this feature, because it is not worth it.

As for all packages that are globally installed command line utilities, it is easy for users to miss out on updates.
This is why many of them, like npm for example, incorporate periodic update checks and display a message on the command line starting that a new version is available and how to update the package.
I found three packages doing this

• check-kit
• update-notifier
• update-check

Conveniently, the check-kit readme contains a comparison table including all three of them.

update-notifier is by far the most used one with several thousand dependents. The real downside is that it will create and display the notification by itself whereas check-kit and update-check both allow to craft the message to your own liking. On the other hand the notification from update-notifier is well-known and understood and safely be considered production ready.

xst package install --repo http://my-private-repo my-package.xar

The underlying implementation in node-exist already supports this.

Remove files in an existdb instance, mimicking the unix rm program.

xst rm <resource> [options]

Options

• --force, -f: force removal of collections that are not empty
• --recursive, -r: traverse the entire collection tree when removing
• --glob, -g: only remove items that match the given glob pattern
• --dry-run, -d: show which items would be removed

refs eXist-db/node-exist#208

xst get <source> [<target>]

followup of eXist-db/node-exist#209

Use Cases

• Download an entire collection from exist to current working directory
  xst get /db/temp
• Download an entire collection from exist to target directory
  xst get /db/temp /tmp
• Download specific resource to target folder with the same name (defaults to current working directory if not set)
  xst get /db/temp/resource.xml
xst get /db/temp/resource.xml ~/test
xst get /db/temp/resource.xml ./subfolder
• Download specific resource to local file
  xst get /db/temp/resource.xml test.xml
xst get /db/temp/resource.xml ./test.xml
xst get /db/temp/resource.xml ~/test.xml

Possible options

• include - globbing pattern, only files matching the pattern are downloaded
• exclude - globbing pattern, files matching the pattern are excluded
• allow to set serialisation options for XML and JSON resources
• parallel downloads with X-threads