You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is also available here.
CAS Command-line Shell
The CAS command-line shell provides the ability to query the CAS server for help on available settings/modules and various other utility functions.
To invoke and work with the utility, simply execute:
1 java -jar /path/to/cas-server-support-shell-$casVersion.jar
$casVersion needless to say is the CAS version that is deployed.
The interface that is next presented will guide you through with available parameters and methods of querying. You will learn how to launch into the interactive shell and query the CAS engine dynamically.
Make sure you have the proper JCE bundle installed in your
Java environment that is used by CAS, specially if you need to use specific signing/encryption algorithms and methods.
Be sure to pick the right version of the JCE for your Java version. Java versions can be detected via the
java -version command.
Note that the WAR Overlay deployment strategy should already be equipped with this functionality. You should not have to do anything special and extra to interact with the shell. See the relevant overlay documentation for more info on how to invoke and work with the shell.