Download Nuxeo Enterprise Platform

Chapter 45. The Nuxeo Shell
45.1. Overview
The Nuxeo Shell is a command line tool for everyone who needs simple and quick remote access to a Nuxeo
EP server. You can see it as the Swiss army knife for the Nuxeo EP world. It can be used by regular users to
browse or modify content, by advanced users to administrate Nuxeo servers, or by programmers to test and
debug.
The Nuxeo Shell is designed as an intuitive and extensible command line application. It can both serve as a
user, administrator or programmer tool, or as a framework to develop new Nuxeo command line clients.
The application is based on the Nuxeo Runtime framework and thus offers the same extension point mechanism
you can find on the server application.
The main features of the command line tool are:
• Two operating modes: an interactive and a batch mode.
• Advanced command line editing like:
• auto-completion
• command history
• command line colors
• command line shortcuts like: CTRL+K, CTR+A, etc.
• JSR223 scripting integration. You can thus connect and execute commands on a Nuxeo server in pure
scripting mode.
• Extensibility - using Nuxeo Runtime extension points
The advanced command line handling is done using the JLine library.
The only requirement is Java 5+. The tool works on any Unix-like OS, on Windows and on Mac OS X.
45.2. User Manual
The Nuxeo Shell application is packaged as a zip archive. To install it, you need to unzip and copy the content
in a folder.
The application folder structure is as follow:
+ nxshell
+ app
+ bundles
+ config
+ data
+ lib
+ lib
- Launcher.class
- log4j.properties
- launcher.properties
- nxshell.sh
• The lib folder contains JARs needed by the application launcher. The Launcher.class is the application
launcher and launcher.properties contains configuration for the launcher.
• log4j.properties is as you expect the configuration for log4j.
Nuxeo EP 5.1 / 5.2
270