Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width65%

About iCommands

iCommands are a set of commands for Unix and Windows that are used in the iRODS system. Before you can use iRODS iCommands, you must first install iCommands and configure your environment. If you have already set up your environment, skip this step.

To share data with a user, you must give the user at minimum read permission to the parent directory that contains the file and any other parent folders within the folder hierarchy.

Info

To share files and folders in the DE, see Sharing and Unsharing Data Files and Folders in the DE.

Common iCommands

The following table contains some of the more common iCommands:

iCommand optionDescriptionHelp command
ils
ils -A
List contents of iRODS directories
List contents of iRODS directories and all associated permissions
ils -h
ichmod read
ichmod write
ichmod own
ichmod null
Grant read-only permission level for specified user to selected file or folder.
Grant read and write permission level for specified user to selected file or folder.
Grant full ownership permission level for specified user to selected file or folder.
Remove permission level for the user to the file or folder.
ichmod -h

Building iCommands yourself

This page describes how to build iCommands yourself. They are useful if you experience difficulty using the prebuilt iCommands instructions.

For more information on iCommands, see the Quick Start iRODS Install Instructions on the iRODS Wiki. You also can view the list of common iCommands on Using iCommands.

Downloading iCommands

For Windows

  1. Follow the instructions at Windows i-commands.
  2. Configure your icommands.

For Linux, Mac OSX, and other UNIX variants

  1. Download the iRODS package at http://wiki.irods.org/index.php/Downloads.
  2. In a terminal window, enter irodssetup.
  3. Enter the following information in the prompts:

    PromptAnswer
    Build an iRODS server yes?no
    Include additional prompts for advanced settings no?no
    Include GSI no?no
    Include the NCCS Auditing extensions no?no
    Save configuration (irods.config) yes?yes
    Start iRODS build yes?yes

Updating your path

  1. When prompted to update your path during installation:

    User typePath
    csh usersset path=(/usr/local/bin/iRODS/clients/icommands/bin $path)
    sh or bash usersPATH=/usr/local/bin/iRODS/clients/icommands/bin:$PATH
  2. Ignore the following instructions from the iRODS installer:

    Code Block
    If you wish to set the ports to use, set the environment variable
    'svrPortRangeStart' or edit the svrPortRangeStart line in irodsctl.pl.
    See the 'Specifying Ports' page on the irods web site for more.
    
    For i-commands-only builds like this, irodssetup does not
    attempt to create your ~/.irods/.irodsEnv file, so you need to
    create or update it by hand yourself. See the iRODS web site page
    on the User Environment.  You may wish to copy .irodsEnv from
    another host.

Configuring your iCommands

Return to Using iCommands to configure your iCommands.

Need help?

If you have problems or need assistance, see Get Help on the CyVerse website or email Support (support@cyverse.org).

Column
width35%
Panel
bgColorWhiteSmoke
titleColorWhite
titleBGColorSteelBlue
borderWidth1px
titleOn This Page

Table of Contents
maxLevel2
indent20px