SnipSnap Command Line

You can access a running SnipSnap server through a command line client. The client connects to the server using XML-RPC. General format of this is to run snipsnap-utils.jar with admin/password parameters, the URL for the XML-RPC, followed by the specific command you want to issue and its arguments.

Dumping a SnipSnap instance to a file:

• java -Xmx512m -jar snipsnap/lib/snipsnap-utils.jar -url http://localhost:8668/$prefix -user $admin -password $passwd snipSnap.dumpXml /$prefix > $prefix.snip

ATTENTION: It looks like a bug in the utils jar converts some characters to '?' Try to dump using the setup web page.

Restoring a SnipSnap instance from a file:

• java -Xmx512m -jar snipsnap/lib/snipsnap-utils.jar -user $admin -password $passwd -url http://localhost:8668/ snipSnap.restoreXml /$prefix file:$prefix.snip

(On this, also see Backup and Restore.)

Creating a new instance from the command line:

• java -jars snipsnap/lib/snipsnap-utils.jar -user $admin -password $passwd -url http://localhost:8668/ snipSnap.install /$prefix $admin $passwd

Adjust the heap size to your needs (i.e. your instance size). $prefix is obviously your instance name, $admin is your admin account, and $passwd that account's password.

You don't have to be on the localhost---this works across a network. Your port may vary. Also, calling your backup files .snip is just a convention; could be .xml as well (that's what's being dumped).

Additional information can be reverse engineering from the source code at org.snipsnap.xmlrpc.SnipSnapHandler and related classes.