Using the Command Window

Note: For a list of available commands, see Administrative Commands sections in the help. All commands are available to Account Administrators. A subset of commands are available to Space Administrators.

Birst provides a set of administrative commands for common activities related to provisioning users and groups, managing spaces, and more. Admins are able to access the Command Window from Space Management in Admin.

To execute from the Command Line:

  1. From Admin, select Space Management. Then, select a space and click Command Window.


  2. Use Search to find text in the Command Help.
    The right panel displays the Command Help.

    Note: To collapse the command help panel, click the arrow icon.
  3. Enter the command with your arguments.
    For the example syntax in the Command Help, the square brackets [] signify arguments and values. They are not delimiters and should not be include in the command. Items enclosed in braces {} are optional. Do not include the braces when specifying the optional arguments. Arguments with spaces should be enclosed with double quotes, like "Enterprise Space".


  4. Click Execute. The results of your command will display in the command window.