Skip to Content.
Sympa Menu

grouper-dev - Re: [grouper-dev] GSH help text

Subject: Grouper Developers Forum

List archive

Re: [grouper-dev] GSH help text

Chronological Thread 
  • From: Tom Barton <>
  • To: Chris Hyzer <>
  • Cc: Grouper Dev <>
  • Subject: Re: [grouper-dev] GSH help text
  • Date: Sat, 13 Sep 2008 11:23:07 -0500

Looks good. Maybe omit the URL, or put it in the help text? Also, I think confluence short URLs are pretty fragile - they aren't maintained across some operations, like maybe renaming a page or moving it under a new parent.

Should the help text include the following basic instruction?

* var = method(args) Invoke any Grouper API method


Chris Hyzer wrote:

We discussed in the last call about the need for GSH help, right?

There is a help() command in GSH which displays all the command (at least, a bunch of them, not sure if all). Anyways, we could get this up to date, or make it more sophisticated… we could easily have a menu type help system:

gsh-0.1.1 0% help()

GSH is Grouper Shell. It is an interpreted shell for invoking Grouper operations.

Please clarify which part of GSH you would like help with, e.g.




… and we will list all of them …

Then when one is specified, we can give a bunch of info about those operations… maybe copied from the WIKI.

Anyways, when GSH starts up, I printed out how to get help and the URL of the wiki. Here is what it prints now…



Type help() for instructions, or visit:

gsh-0.1.1 0% help()


* addComposite(group, type, left group, right group)

* addGroup(parent, extension, displayExtension)

* addMember(group, subject id)

* addRootStem(extension, displayExtension)

* addStem(parent, extension, displayExtension)

* addSubject(id, type, name)

* delComposite(group)

* delGroup(name)

* delMember(group, subject id)

* delStem(name)

* exit

* findSubject(id)

* findSubject(id, type)

* findSubject(id, type, source)

* getGroupAttr(stem, attr)

* getGroups(name)

* getMembers(group)

* getSources()

* getStemAttr(stem, attr)

* getStems(name)

* grantPriv(name, subject id, Privilege)

* hasMember(group, subject id)

* hasPriv(name, subject id, Privilege)

* help()

* history()

* history(n)

* last()

* last(n)

* p(command)

* quit

* resetRegistry()

* registryInstall() will insert default Grouper data if not there, e.g. root stem

* revokePriv(name, subject id, Privilege)

* setGroupAttr(stem, attr, value)

* setStemAttr(stem, attr, value)

* typeAdd(name)

* typeAddAttr(type, name, read, write, req)

* typeAddList(type, name, read, write)

* typeDel(name)

* typeDelField(type, name)

* typeFind(name)

* typeGetFields(name)

* version()





gsh-0.1.1 1%

fn:Tom Barton
org:University of Chicago;Networking Services & Information Technologies
title:Sr. Director for Integration
tel;work:+1 773 834 1700

Archive powered by MHonArc 2.6.16.

Top of Page