Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

The CLI installation process has changed! The new, easier, automated installation process is customized for Linux, MacOS, and Windows.


On this page:

Table of Contents
maxLevel1
absoluteUrltrue
typeflat
separatorpipe


Note
titleCertain Atlassian products require a companion app

After installation, if your client reports a licensing error running some actions, ask your Atlassian site administrator to install the Atlassian CLI companion app for Jira, Confluence, Bitbucket Server, or Bamboo in order to use the Bob Swift Atlassian CLI with those Atlassian products.

Installing on Linux, MacOS, and Windows desktops

The MacOS desktop UI is shown in the illustrations below.

  1. Download and launch the installer for your OS (Linux , MacOS, or Windows).

  2. Click “Next” once you have read the welcome message from Bob Swift




  3. Accept the End User License Agreement (EULA) and click “Next”.
    If you do not wish to accept the EULA select “I do not accept the agreement” and click “Next” or click “Cancel”.



  4. Select where you wish to install the Bob Swift CLI. This defaults to the folder “ACLI” underneath your user directory.



  5. Optionally enroll in a getting started email newsletter subscription. Clear the checkbox to decline enrollment.



  6. If your installation directory contains a Bob Swift CLI installation prior to 9.2, then you will be prompted to confirm whether to overwrite it and given the option for the installer to make backups of user modifiable files.



  7. Choose how you would like to initially configure the Bob Swift CLI installation and then click “Next”. Based on your selection the installer may prompt you for additional connection properties:



    1. Configure CLI connections for:

      1. Atlassian’s Cloud (Jira + Confluence)
        Configure the CLI to connect to an Atlassian hosted instance of Jira (and Confluence if subscribed).

      2. Self hosted server(s)
        Choose this option if you self-host (in your own data center or in a private cloud) the Server or Data Center editions of Jira and/or Confluence.

      3. None (skip this configuration)
        The installer will configure example CLI connections, but will not prompt for any additional connection properties.

    2. Add your installation directory to the user path…
      The installer will configure your environment to make it easier to launch the Bob Swift CLI from any location on your desktop.

    3. Run a simple test of the CLI to verify it is working.
      The installer will use the configuration information from this dialog to create a test script to verify the CLI installed correctly.

  8. The next installer dialogs will vary based on your CLI connections selection in the previous dialog:

    1. Atlassian’s Cloud (Jira + Confluence)



      1. Jira URL: The web address of your Atlassian hosted Jira instance.

      2. Connection name (no spaces): A nickname for this connection for easy reference when issuing CLI commands to be executed using this connection.

      3. Login required…: Indicates if the Jira instance requires a user email and API token to connect or not (aka anonymous access).

        1. User Email: The email address of the user account with which the CLI should connect.

        2. API token: The API token of the user account with which the CLI should connect. API tokens are required by the Atlassian cloud to connect (login) when not using a web browser.

    2. Self hosted server(s)
      This applies to both Jira and Confluence although Jira is used in the example below.



      1. Jira URL: The web address of your self hosted instance.

      2. Connection name (no spaces): A nickname for this connection for easy reference when issue CLI commands to be executed using this connection.

      3. Login required…: Indicates if the Jira instance requires a user name and password to connect or not (aka anonymous access).

        1. User Name: The user account name with which the CLI should connect.

        2. Password: The password for the user.

  9. The installer is now to ready to install the Bob Swift CLI and apply your configuration preferences.



  10. The Installer will show progress of setup.

  11. If you chose “Run a simple test of the CLI to verify it is working” earlier you will see the results of the test. The test results will vary based on your earlier configuration selections.



  12. Once concluded, the Installer presents an option to view the readme file for the installed release.



  13. You can now launch the Bob Swift CLI:

    1. From the Desktop shortcut or Start menu in Windows

    2. The Launchpad on MacOS.

    3. The console command: acli in Linux, MacOS, and Windows.

Installing on Linux servers

Note: This applies to Linux servers without a graphical desktop environment. The Linux installer will not run in the MacOS terminal.

Expand
titleClick to expand
  1. Mark the installer file as executable: chmod +x ./ACLI-9.3.0-installer.run

  2. Start the installer with the following command: ./ACLI-9.3.0-installer.run

  3. The installer will present a welcome message from Bob Swift and prompt to review the End User License Agreement (EULA).

    Code Block
    languagetext
        ____        __       _____         _ ______
       / __ )____  / /_     / ___/      __(_) __/ /_
      / __  / __ \/ __ \    \__ \ | /| / / / /_/ __/
     / /_/ / /_/ / /_/ /   ___/ / |/ |/ / / __/ /_
    /_____/\____/_.___/   /____/|__/|__/_/_/  \__/
    
        ___   __  __                _                __
       /   | / /_/ /___ ___________(_)___ _____     /   |  ____  ____  _____
      / /| |/ __/ / __ `/ ___/ ___/ / __ `/ __ \   / /| | / __ \/ __ \/ ___/
     / ___ / /_/ / /_/ (__  |__  ) / /_/ / / / /  / ___ |/ /_/ / /_/ (__  )
    /_/  |_\__/_/\__,_/____/____/_/\__,_/_/ /_/  /_/  |_/ .___/ .___/____/
    
    ----------------------------------------------------------------------------
    You're a few clicks away from unleashing hundreds of unique, automated actions 
    across your Atlassian tools.
    
    Since I first started developing the CLI clients in 2007, we've added support 
    for hundreds of unique actions across Jira, Confluence, Bitbucket, Bamboo, and 
    more.
    
    I think you'll find that once you have this much control at your fingertips, 
    you'll want to automate more and more tasks to save time, cut down on manual 
    work, and standardize your processes. And if you have any questions, please 
    don't hesitate to reach out.  We're here to help!
    
    Thank you for inspiring us to create great products.
    You're the reason we build software! :)
    
    - Bob Swift
    
    ----------------------------------------------------------------------------
    Please review the end user license agreement and accept the agreement in order 
    to proceed with the installation.  The Bob Swift CLI client distribution and CLI 
    add-ons includes a variety of open source libraries.  Those licenses may be 
    found in the license folder beneath the installation folder.
    
    Press [Enter] to continue:


  4. Review the EULA and press enter/return to proceed. Type ‘y' and press enter/return to accept or 'n’ and press enter/return to decline and cancel the installation.

    Code Block
    Copyright (c) 2005, 2020 Appfire Technologies, Inc.
    All rights reserved.
    
    This software is licensed under the provisions of the "Bob Swift Atlassian App 
    EULA"
    (https://bobswift.atlassian.net/wiki/x/WoDXBQ) as well as under the provisions 
    of
    the "Standard EULA" from the "Atlassian Marketplace Terms of Use" as a 
    "Marketplace Product"
    (http://www.atlassian.com/licensing/marketplace/termsofuse).
    
    Press [Enter] to continue:
    
    Do you accept this license? [y/n]: 


  5. Specify where you wish to install the Bob Swift CLI. This defaults to the folder “ACLI” underneath your user directory. Optionally type a new destination and press enter/return. Press enter/return without typing to accept the default.

    Code Block
    ----------------------------------------------------------------------------
    Please specify the directory where Bob Swift Command Line Interface (CLI) will 
    be installed.
    
    Installation Directory [/home/bobswift/ACLI]:


  6. Optionally enroll in a getting started email newsletter subscription. Type ‘n' and enter/return to decline enrollment. Otherwise type 'y’ and/or enter/return to provide your contact information.

    Code Block
    May we send you helpful getting started articles? [Y/n]:
    
    ----------------------------------------------------------------------------
    Get help getting started
    
    We have a wealth of knowledge we'd like to share with you to get the most out of 
    the CLI.
    
    Email: []: bobswift@examplegear.com
    
    First name []: Bob
    
    Last name []: Swift
    


  7. If your installation directory contains a Bob Swift CLI installation prior to 9.2, then you will be prompted to confirm whether to overwrite it and given the option for the installer to make backups of user modifiable files.

    Code Block
    Overwrite existing CLI files [y/N]: y
    
    ----------------------------------------------------------------------------
    The installer found evidence of what appears to be a previous CLI installation 
    in /home/bobswift/ACLI.
    
    The installation can make backups (.bak) of properties files and scripts. It 
    will remove no longer needed files in the lib folder, and replace files found in 
    the license folder.
    
    If you wish to preserve any files seperately, please make a backup of them 
    before proceeding with the installation.
    
    
    Create backup (.bak) files [y/N]: 


  8. Choose how you would like to initially configure the Bob Swift CLI installation and then click “Next”. Based on your selection the installer may prompt you for additional connection properties.
    In the illustration below option 1 (Atlassian’s Cloud (Jira + Confluence) is selected.

    1. Configure CLI connections for:

      1. Atlassian’s Cloud (Jira + Confluence)
        Configure the CLI to connect to an Atlassian hosted instance of Jira (and Confluence if subscribed).

      2. Self hosted server(s)
        Choose this option if you self-host (in your own data center or in a private cloud) the Server or Data Center editions of Jira and/or Confluence.

      3. None (skip this configuration)
        The installer will configure example CLI connections, but will not prompt for any additional connection properties.

    2. Add your installation directory to the user path…
      The installer will configure your environment to make it easier to launch the Bob Swift CLI from any location on your desktop.

    3. Run a simple test of the CLI to verify it is working.
      The installer will use the configuration information from this dialog to create a test script to verify the CLI installed correctly.

      Code Block
      ----------------------------------------------------------------------------
      Installation options
      
      Configure CLI connection(s) for:
      
      [1] Atlassian's Cloud (Jira + Confluence)
      [2] : Self hosted server(s)
      [3] None (skip configuration)
      Please choose an option [1] : 
      
      Atlassian's Cloud (Jira + Confluence)
      
      Add '/home/bobswift/ACLI' to the user path so you can run the CLI from any 
      directory. [Y/n]: 
      
      Run a simple test of the CLI to verify it is working. [Y/n]: 
      


  9. Provide CLI connection properties:
    Configuration options in the illustration below continue to reflect option 1 (Atlassian’s Cloud (Jira + Confluence) from the previous step.

    1. Jira URL: The web address of your Atlassian hosted Jira instance.

    2. Connection name (no spaces): A nickname for this connection for easy reference when issuing CLI commands to be executed using this connection. Defaults to ‘default’.

    3. Login required…: Indicates if the Jira instance requires a user email and API token to connect or not (aka anonymous access). Defaults to 'Y'.

      1. User Email: The email address of the user account with which the CLI should connect.

      2. API token: The API token of the user account with which the CLI should connect. API tokens are required by the Atlassian cloud to connect (login) when not using a web browser.

        Code Block
        ----------------------------------------------------------------------------
        Configure your Jira connection
        
        Jira URL []: https://bobswift.atlassian.net
        
        Connection name (no spaces) [default]: 
        
        Login required (Untick to connect anonymously) [Y/n]: 
        
        ----------------------------------------------------------------------------
        User Email []: bobswift@examplegear.com
        
        API token []: a61df446ac90468fb2b8839831938e18


  10. The installer is now to ready to install the Bob Swift CLI and apply your configuration preferences.

    Code Block
    ----------------------------------------------------------------------------
    Setup is now ready to begin installing Bob Swift Command Line Interface (CLI) on your computer.
    
    Do you want to continue? [Y/n]:
    


  11. The installer will now show progress of setup.

    Code Block
    ----------------------------------------------------------------------------
    Please wait while Setup installs Bob Swift Command Line Interface (CLI) on your computer.
    
     Installing
     0% ______________ 50% ______________ 100%
     ########################################


  12. If you chose “Run a simple test of the CLI to verify it is working” earlier you will see the results of the test. The test results will vary based on your earlier configuration selections.

    Code Block
    Info: Now testing the Bob Swift CLI.  
    In the next screen you will see the 
    results of the CLI gathering information about your CLI configuration.
    
    Press [Enter] to continue: 
    
    CLI Testing Results
    Below are the results of testing the CLI using the configuration information 
    provided earlier.  
    
    Client information
    
    Client name . . . . . . . . . : cli
    Client version  . . . . . . . : 9.3.0-SNAPSHOT
    Client description  . . . . . : Base client for the Atlassian Command Line 
    Interface.
    Client usage  . . . . . . . . : The cli client is the base for all other clients 
    and defines common actions and parameters.
    OS name . . . . . . . . . . . : Linux
    OS version  . . . . . . . . . : 5.0.0-38-generic
    Java name . . . . . . . . . . : OpenJDK 64-Bit Server VM
    Java version  . . . . . . . . : 11.0.6
    Java arguments  . . . . . . . : -Dfile.encoding=UTF-8
    Used memory (MB)  . . . . . . : 3
    Free memory (MB)  . . . . . . : 12
    Total memory (MB) . . . . . . : 15
    Max memory (MB) . . . . . . . : 237
    Default encoding  . . . . . . : UTF-8
    Configuration file  . . . . . : /home/bobswift/ACLI/acli.properties
    
    Server info
    
    Product . . . . . . . . . . . : Jira
    Hosting . . . . . . . . . . . : cloud
    Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT
    Base URL  . . . . . . . . . . : https://bobswift.atlassian.net
    Title . . . . . . . . . . . . : Jira for Bob Swift Atlassian Apps
    Build . . . . . . . . . . . . : 100122
    Build date  . . . . . . . . . : 3/18/20, 12:44 AM
    Current time  . . . . . . . . : 
    License information . . . . . : Not available for this Cloud instance.
    Client  . . . . . . . . . . . : jiracloud
    User  . . . . . . . . . . . . : anonymous
    Response time (milliseconds)  : 982
    
    Press [Enter] to continue:
    


  13. Once concluded, the Installer presents an option to view the readme file for the installed release. Defaults to 'Y'.

    Code Block
    ----------------------------------------------------------------------------
    Setup has finished installing Bob Swift Command Line Interface (CLI) on your computer.
    
    View Readme file? [Y/n]:


  14. You can now launch the Bob Swift CLI via the console command: acli.

Previous versions

Cql query
showLastModifierColumnfalse
showQueryfalse
showCreatorColumnfalse
showLastModifiedDateColumnfalse
cqlQueryparent = 16875586 order by title desc
showCreatedDateColumnfalse
limitEnum25
showTypeColumnfalse
showSpaceColumnfalse
showLabelsColumnfalse