strut - command line interface (using Socialtext::Resting) to the Socialtext REST services
strut help strut configure strut list_workspaces strut list_pages <workspace> strut get_page <workspace> <pagename> strut set_page <workspace> <pagename> <filename> strut list_tags <workspace> <pagename> strut put_tag <workspace> <pagename> <tag> strut set_tags <workspace> <pagename> <tags> strut list_tagged_pages <workspace> <tag> strut list_attachments <workspace> <pagename> strut get_attachment <workspace> <pagename> <attachment> strut add_attachment <workspace> <pagename> <filename> strut show_breadcrumbs <workspace> strut show_backlinks <workspace> <pagename> strut show_frontlinks <workspace> <pagename> All list operations can further be controlled with the following operations: --query (search term for within the results) --filter (filter the titles of the results) --order (only accepts 'newest' right now) --count (restrict number of returned results) --accept (for your accept headers - text/html, text/plain, application/json) Example: strut --query=searchterm --filter=titlefilter --order=newest --count=number list_pages myworkspace
The following commands are supported
Standard man page for this program
Configure strut with username, password, and server information. See the CONFIGURATION section below for a discussion of your configuration options.
Get the breadcrumbs for the current user in this workspace.
Give a list of all workspaces on the server
List the tags for a workspace.
Give a list of all pages in the given workspace. If no workspace is given you will be prompted to pick from available workspaces.
Give a list of all pages in the given workspace with the given tag.
Retrieve the contents of the specified page. If no workspace or page are given the user will be prompted to select from the available workspaces/pages.
Save the specified page on the system.
Add the attachment to the specifed page on the system.
List all attachments on the specified page.
List all tags on the specified page.
Show backlinks to the specified page name.
Show frontlinks to the specified page name.
Add the specified tag to the specified page name.
Set the tags for the specified page name.
In order to run correctly, strut needs to have a username, password, and server name. This can be configured in one of several ways:
strut --username <username> --password <password> --server <server>
STRUT_USERNAME STRUT_PASSWORD STRUT_SERVER
~/.app/strut.conf
If strut can't determine your username/password/server, it will call the 'configure' subcommand to create a configuration file for you.
<chris.dent@socialtext.com> <kirsten.jones@socialtext.com>
To install Socialtext::Resting, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Socialtext::Resting
CPAN shell
perl -MCPAN -e shell install Socialtext::Resting
For more information on module installation, please visit the detailed CPAN module installation guide.