README.md
changeset 85 7eb0c972e515
child 86 9a5dacf95052
equal deleted inserted replaced
84:ef002a0b0867 85:7eb0c972e515
       
     1 Shelldap
       
     2 ========
       
     3 
       
     4 A handy shell-like interface for browsing LDAP servers and editing their
       
     5 content. It keeps command history, has sane autocompletes, credential caching,
       
     6 site-wide and individual configs, and it's fun to say.
       
     7 Shelldap! Shelldap! Shelldap!
       
     8 
       
     9 Witness!
       
    10 
       
    11 
       
    12 ```
       
    13 % shelldap 
       
    14 ~ > [ tab ]
       
    15 ~ > 
       
    16 cat     clear   cp      delete  env     grep    id      ls      move    passwd  read    search  touch   whoami  
       
    17 cd      copy    create  edit    exit    help    list    mkdir   mv      pwd     rm      setenv  vi      
       
    18 ~ > cd ou=People
       
    19 ou=People,~ > cat uid=ma[ tab ]
       
    20 ou=People,~ > cat uid=mahlon
       
    21 
       
    22 dn: uid=mahlon,ou=People,dc=laika,dc=com
       
    23 objectClass: inetOrgPerson
       
    24 objectClass: organizationalPerson
       
    25 objectClass: person
       
    26 objectClass: top
       
    27 objectClass: posixAccount
       
    28 objectClass: shadowAccount
       
    29 objectClass: apple-user
       
    30 cn: Mahlon E. Smith
       
    31 departmentNumber: Technology - IT
       
    32 displayName: Mahlon
       
    33 gecos: Mahlon E. Smith
       
    34 gidNumber: 200
       
    35 givenName: Mahlon
       
    36 homeDirectory: /home/m/mahlon
       
    37 l: Ghetto
       
    38 loginShell: /bin/tcsh
       
    39 mail: mahlon@martini.nu
       
    40 mobile: 1+8829999005747
       
    41 sn: Smith
       
    42 title: Manager, Information Systems
       
    43 uid: mahlon
       
    44 uidNumber: 20933
       
    45 userPassword: *
       
    46 
       
    47 ou=People,~ > 
       
    48 ```
       
    49 
       
    50 
       
    51 Downloads
       
    52 ---------
       
    53 
       
    54 You can download the latest script [here](http://code.martini.nu/shelldap/archive/tip.zip).
       
    55 
       
    56 It is also available via the 
       
    57 [FreeBSD ports](http://www.freebsd.org/cgi/cvsweb.cgi/ports/net/shelldap/) system, OS X via 
       
    58 [macports](http://shelldap.darwinports.com/), Debian/Ubuntu via [apt](https://packages.debian.org/shelldap),
       
    59 NetBSD's [pkgsrc](ftp://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/sysutils/shelldap/README.html), OpenBSD [ports](http://openports.se/sysutils/shelldap/), and openSUSE's [build service](http://software.opensuse.org/search?q=shelldap&baseproject=openSUSE%3AFactory&lang=en).
       
    60 
       
    61 Many thanks to the maintainers of these packages.
       
    62 
       
    63 
       
    64 Installation
       
    65 -------------
       
    66 
       
    67 Shelldap is simply a perl script.  Put it into a convenient place of your choosing.
       
    68 
       
    69 Shelldap requires the following perl modules to function properly:
       
    70 
       
    71 * YAML::Syck
       
    72 * Term::Shell
       
    73 * Digest::MD5 
       
    74 * Net::LDAP
       
    75 * Algorithm::Diff
       
    76 
       
    77 Additional functionality is supported with the presence of:
       
    78 
       
    79 * IO::Socket::SSL
       
    80 * Authen::SASL
       
    81 
       
    82 
       
    83 Development
       
    84 -----------
       
    85 
       
    86 
       
    87 You can also check out the source via [Mercurial](http://mercurial.selenic.com/wiki/) from the following uri:
       
    88 
       
    89     % hg clone http://code.martini.nu/shelldap/
       
    90 
       
    91 or via [BitBucket](http://bitbucket.org/) at:
       
    92 
       
    93     % hg clone https://bitbucket.org/mahlon/shelldap
       
    94 
       
    95 
       
    96 Documentation
       
    97 -------------
       
    98 
       
    99 Once installed, Shelldap is fully documented via perldoc, and has a built-in `help` command as well.