Skip to content

Latest commit

 

History

History
121 lines (75 loc) · 4.05 KB

README.md

File metadata and controls

121 lines (75 loc) · 4.05 KB

IBM Developer Tools CLI Installer (idt-installer) for Linux and MacOS

Platform

Table of Contents

Summary

This script performs an installation of the IBM Developer Tools CLI environment. The IDT consists of the 'dev' (and several other) plugins to the IBM Cloud CLI. Our general target environment is the IBM Cloud, including public, dedicated, and local hybrid.

Installation

To install the IBM Cloud Developer Tools CLI, run the following command:

$ curl -sL https://ibm.biz/idt-installer | bash

Once complete, there will be three added shortcuts defined to access the IDT:

  • ibmcloud dev : Main command line tool for IBM cloud native development
  • ibmcloud update : Update your IBM Cloud CLI to the latest version
  • ibmcloud plugin update : Update IBM Cloud plugins to the latest versions

Debugging

If you have any issues with the installer, try running with the --trace argument which will produce verbose output to assist us in diagnosing your problem:

curl -sL https://ibm.biz/idt-installer | bash -s -- --trace

If you wish to update the IBM Cloud Dev Plugin, run:

ibmcloud plugin update dev

Updating

If you wish to update the IBM Cloud Dev Plugin, run ibmcloud plugin update dev.

Syntax:

ibmcloud plugin update dev

Pre-Requisites

The script will check for the following prereqs, and attempt to install them if not found.

  • Git command line
  • Docker command line
  • Kubernetes CLI (kubectl)

Usage

Usage: idt-installer [<args>]

Where <args> is:
    install | update    [Default] Perform full install (or update) of all needed CLIs and Plugins
    help | -h | -?      Show this help
    --force             Force updates of dependencies and other settings during update
    --trace             Eanble verbose tracing of all activity


If "install" (or no action provided), a full CLI installation (or update) will occur:
  1. Pre-req check for 'git', 'docker', and 'kubectl'
  2. Install latest IBM Cloud 'ibmcloud' CLI
  3. Install all required plugins
  4. Defines aliases to improve useability
      - ic : Shortcut for "ibmcloud" command


Chat with us on Slack: https://slack-invite-ibm-cloud-tech.mybluemix.net/
Submit any issues to : https://github.com/IBM-Cloud/ibm-cloud-developer-tools/issues

Platforms

The following are platform specific concerns and notes you should be aware of.

Note: Previous versions of this installer set up aliases within you shell env (ie ~/.bashrc). Current version have switched over to use a wrapper shell scripty (/usr/local/bin/idt) to achieve better results. The old env entries are automatically removed.

MacOS

The installer uses the "homebrew" utility, and it will be installed as needed.

Linux

This script has only been tested on Ubuntu Linux systems, although it should behave properly on other distros that use 'apt-get'.

If you run into any issues, please let us know on IBM Cloud Tech Slack - #developer-tools channel, or file an issue on our GitHub repo.

Windows

WARNING: Windows is not supported by this installer. See the Windows installation for additional information.

Internal IBM users

IBM users can use pre-release versions of the IDT (ibmcloud and all plugins). The installer will check if you have the internal "stage1" plugin repo defined, and ask if you want to use it for updates. Note: Since during initial install of the ibmcloud CLI does not have extra plugin repos defined, it only applies during subsequent updates.