The Nuxeo Shell

Command options are defined by a name and optionally a shortcut (a short name). When referring to an option using its name you should prefix it by two hyphens '--'. When using short names you should only use one hyphen as a prefix. For example if you have an option named "host" and using a short name of "h" the following commands are equivalent:

$ ./nxshell.sh interactive -h localhost

$ ./nxshell.sh interactive --host localhost

Options may take values or may be used as flags turning on / off a specific option by their simple presence.

When using long names you should specify the option values immediately after the option. However when using short names you can group options together. Let say for example we have a command that support 4 options: a, v, i, o. a and v are flag options and both i and o takes an argument as value. In this case the you can group options like the following:

command -avi in_file -o out_file

or

command -avio in_file out_file

or anyhow you want. You should keep in mind that when grouping options that take arguments, these arguments will be assigned to each of this options in the order they were specified on the command line.

There is the list of all built-in commands of nuxeo shell.

Notes:

$ ./nxshell.sh interactive

$ ./nxshell.sh help ls

log4j:WARN No appenders could be found for logger (org.nuxeo.ecm.shell.commands.InteractiveCommand).
log4j:WARN Please initialize the log4j system properly.

script --file <path_to_your_script> <args>

useradd joe

useradd --file users.csv

groupmod --user joe company-service1

groupmod --set --user madarche company-service1

groupmod --file users_for_group.csv company-service1

groupmod --file users_for_group.csv company-service1

select * from Document where ...

Be sure on what precise IP address and what precise port the server is listening to. To find out, use the netstat command on the server host. The example below shows that, on the same host, there are 2 servers listening on the 62474 port but on different IP addresses. You should always use as arguments to the nuxeo shell the exact IP address and port you find out.

$ sudo netstat -ntlap | grep 62474
tcp        0      0 ::ffff:192.0.0.11:62474     :::*                        LISTEN      3623/java
tcp        0      0 ::ffff:192.0.0.10:62474     :::*                        LISTEN      1346/java      

Alternatively you can use the lsof command.

$ sudo lsof -i :62474
COMMAND   PID       USER   FD   TYPE    DEVICE SIZE/OFF NODE NAME
java     3623      jboss  266u  IPv6 0x5d69a70      0t0  TCP [::192.0.0.11]:62474 (LISTEN)
java     1346      jboss  266u  IPv6 0x5d7af30      0t0  TCP [::192.0.0.10]:62474 (LISTEN)      

Be sure to be connected on the right server. To do so, issue a view command. This will display information on the current context:

192.0.0.10> view
--------------------------------------------------------------------
UID: 2a13db70-f133-473c-9a90-6838d01610aa
Path: /
Type: Root
--------------------------------------------------------------------
Title: 2a13db70-f133-473c-9a90-6838d01610aa
Author: null
Created: null
Last Modified: null
--------------------------------------------------------------------
Description: 2a13db70-f133-473c-9a90-6838d01610aa
--------------------------------------------------------------------      

When working with multi-machine installation, connect the Nuxeo Shell on the server running Nuxeo Core (i.e. the stateful server on a bi-machine configuration).

This is how to register the new commands:

<?xml version="1.0"?>
<component name="com.company.nuxeo.shellcommands" version="1.0">

  <documentation>
    Extra Nuxeo Shell commands shown as examples for the Nuxeo Book.
  </documentation>

  <extension target="org.nuxeo.ecm.shell.CommandLineService" point="commands">

    <command name="purgeobsoletedocs" class="com.company.nuxeo.shellcommands.ObsoleteDocsPurgeCommand">
      <description>
        Purge obsolete documents considering based on predefined hard-coded logic.
      </description>
      <help>Purge obsolete documents</help>
    </command>

    <command name="addapplicants" class="com.company.nuxeo.shellcommands.ApplicantsAdderCommand">
      <description>
        Adds applicants by creating the right folders with the right permissions.
      </description>
      <params>
        <param index="0" type="path" />
      </params>
      <help>Adds applicants</help>
    </command>

  </extension>

</component>
      

This is how to write a Java class for a new command:

public class ApplicantsAdderCommand extends AbstractCommand {

    public static final String COMMAND_NAME = "addApplicants";

    public void run(CommandLine cmdLine) throws Exception {
        String[] elements = cmdLine.getParameters();
        // parse command line
        if (elements.length != 1) {
            log.error("Usage: " + COMMAND_NAME + " file");
            return;
        }
        File file = new File(elements[0]);

        addApplicants([...]);
    }

    void addApplicants([...]) {
    }

}
      

Finally the pom.xml file for the plugin to the Nuxeo shell needs to at least contain the following dependency to be able to build extend the AbstractCommand class. Building the plugin will generate a XXX.jar file. Note that you should of course replace the version given as an example with the version suited for your need.

<dependencies>

  [...]

  <dependency>
    <groupId>org.nuxeo.ecm.platform</groupId>
    <artifactId>nuxeo-shell-commands-base</artifactId>
    <version>5.1.7-SNAPSHOT</version>
  </dependency>

  [...]

</dependencies>
      

The next time the nuxeo shell is restarted your new commands will be available.