Skip to content

Commit

Permalink
Merge pull request #31 from IBM-Cloud/beta
Browse files Browse the repository at this point in the history 
Beta
  • Loading branch information
Karl Bishop authored Jan 10, 2018
2 parents 0271071 + 8752160 commit 3fdacda
Show file tree
Hide file tree
Showing 6 changed files with 726 additions and 374 deletions.
23 changes: 6 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# IBM Cloud Developer Tools

[![](https://img.shields.io/badge/IBM%20Cloud-powered-blue.svg)](https://bluemix.net)
![Platform](https://img.shields.io/badge/platform-BASH-lightgrey.svg?style=flat)
![Platform](https://img.shields.io/badge/platform-PowerShell-lightgrey.svg?style=flat)

This repo provides support for the IBM Cloud Developer Tools (IDT) CLI environment. The IDT tools currently consists of the IBM Cloud CLI (bx) 'dev' and other plugins, as well as extensions to multiple IDEs.

Expand All @@ -12,7 +10,7 @@ These tools work for the following environments:
- [IBM **Cloud** Dedicated](https://www.ibm.com/cloud-computing/bluemix/dedicated)
- [IBM MicroService Builder](https://developer.ibm.com/microservice-builder/)

If you run into any issues, please let us know on the [IBM Cloud Tech Slack :: #developer-tools](https://slack-invite-ibm-cloud-tech.mybluemix.net/) or file an issue on our [GitHub repo](https://github.com/IBM-Bluemix/ibm-cloud-developer-tools).
If you run into any issues, please let us know on the [IBM Cloud Tech Slack :: #developer-tools](https://slack-invite-ibm-cloud-tech.mybluemix.net/) or file an issue on our [GitHub repo](https://github.com/IBM-Cloud/ibm-cloud-developer-tools).



Expand All @@ -24,19 +22,10 @@ The following command will install the IBM Cloud Developer Tools in a single inv
$ curl -sL https://ibm.biz/idt-installer | bash
```

By default, this installer will use the 'brew' installer on MacOS, if available. If you explicitly do not want to use brew, execute the following command using the `--nobrew` option:

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

Once complete, there will be three aliases defined to access the IBM Cloud Developer Tools:
- `idt` : Main command line tool. Shorthand for standard 'bx dev' command
- `idt-update` : Update your IBM Cloud Developer Tools to the latest versions
- `idt-uninstall` : Uninstall the IBM Cloud Developer Tools

Note: In order to access these aliases, you need to either restart your terminal session,
or reload your bash env (ie `. ~/.bashrc`)
Once complete, there will be three shortcuts defined to access the IBM Cloud Developer Tools:
- `idt` : Main command line tool. Shorthand for 'bx dev' command
- `idt update` : Update your IBM Cloud Developer Tools to the latest versions
- `idt uninstall` : Uninstall the IBM Cloud Developer Tools

Access the [platform-specific readme](./linux-installer/README.md) for additional details.

Expand Down Expand Up @@ -70,5 +59,5 @@ Notice: These extensions are provided "as-is". IBM does not explicitly endorse,

We can be reached in the following ways. We encourage and welcome all feedback and suggestions
- [IBM Cloud Tech Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/): Find us on the `#developer-tools` channel
- [IBM Cloud Developer Tools GitHub repo](https://github.com/IBM-Cloud/ibm-cloud-developer-tools): Use to file any issues specific to installation of the tools
- [IBM Cloud Developer Tools GitHub repo](https://github.com/IBM-Cloud/ibm-cloud-developer-tools): Use to file any issues specific to installation of the tools or the IDE extensions.

12 changes: 12 additions & 0 deletions idt_release_notes.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@

## v1.1.0 Dec 13, 2017
- Integrate DevOps (CF or Kube) during app creation
- Use Docker Compose to Develop a Multi-Container Application
- Launch a Deployed Web Application with View
- Access Local Containers with Shell
- Improved Create Interaction
- Usability Improvements
- and bug fixes

You can read about this new release here: https://www.ibm.com/blogs/bluemix/2017/12/whats-included-ibm-cloud-developer-tools-cli-version-1-1-0/

## v1.0.8 Oct 26, 2018
- modifies the `bx dev console` command for the new location of projects due to the app-services changes to the Public Cloud console.

65 changes: 34 additions & 31 deletions linux-installer/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IBM Developer Tools CLI Installer (idt-installer)
# IBM Developer Tools CLI Installer (idt-installer) for Linux and MacOS

[![](https://img.shields.io/badge/IBM%20Cloud-powered-blue.svg)](https://bluemix.net)
![Platform](https://img.shields.io/badge/platform-BASH-lightgrey.svg?style=flat)
Expand All @@ -19,7 +19,7 @@

## Summary

This script performs an installation of the IBM Developer Tools CLI environment. The IDT is a plugin to the IBM Bluemix CLI. Our general target environment is the IBM Cloud, including public, dedicated, and local hybrid.
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
Expand All @@ -29,43 +29,48 @@ Before running the installation script, you should set this environment variable
export DESIRED_VERSION=v2.4.2
```

To install the IBM Developer Tools CLI, run the following command:
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 aliases defined to access the IDT:
- `idt` : Main command line tool for IBM cloud native development (shortcut to 'bx dev')
- `idt-update` : Update your IDT environment to the latest versions
- `idt-uninstall` : Uninstall the IBM Developer Tools

Note: You will need to either restart your terminal session, or reload your bash environment (ie `. ~/.bashrc`) to access these commands.
Once complete, there will be three added shortcuts defined to access the IDT:
- `idt` : Main command line tool for IBM cloud native development (shortcut to 'bx dev' command)
- `idt update` : Update your IDT environment to the latest versions
- `idt uninstall` : Uninstall the IBM Developer Tools


### Debugging

If you have any issues with the instaler, try running with the `--trace` argument which will produce verbose output to assist us in diagnosing your problem:
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 updating an existing IDT installation, you can run the following:
```
idt update --trace
```


## Updating

If you wish to update the IBM Developer Tools CLI, run `idt-update`. This command is simply an alias defined during initial install that runs the installer shown here:
If you wish to update the IBM Developer Tools CLI, run `idt update`. There is also a `--force` argument that will force update to all dependencies too.

This command is simply an alias defined during initial install that runs the installer shown here:

```
$ curl -sL https://ibm.biz/idt-installer | bash
$ curl -sL https://ibm.biz/idt-installer | bash -c -- [--force]
```

## Uninstall

If you wish to remove the IBM Developer Tools CLI, run `idt-uninstall`. This command is simply an alias defined during install that runs the following:
If you wish to remove the IBM Developer Tools CLI, run `idt uninstall`. This command is simply an alias defined during install that runs the following:

```
$ curl -sL https://ibm.biz/idt-installer | bash -s uninstall
$ curl -sL https://ibm.biz/idt-installer | bash -c -- uninstall
```


Expand All @@ -75,17 +80,18 @@ The script will check for the following prereqs, and attempt to install them if
- Git command line
- Docker command line
- Kubernetes CLI (kubectl)
- Kubernetes helm


## Usage
```
Usage: idt-installer [<args>]
Where <args> is:
install [Default] Perform full install (or update) of all needed CLIs and Plugins
install | update [Default] Perform full install (or update) of all needed CLIs and Plugins
uninstall Uninstall full IBM Cloud CLI env, including 'bx', and plugins
help | -h | -? Show this help
--nobrew Force not using brew installer on MacOS
--force Force updates of dependencies and other settings during update
--trace Eanble verbose tracing of all activity
Expand All @@ -95,28 +101,33 @@ If "install" (or no action provided), a full CLI installation (or update) will o
3. Install all required plugins
4. Defines aliases to improve useability
- idt : Shortcut for normal "bx dev" command
- idt-update : Runs this installer checking for and installing any updates
- idt-uninstall : Uninstalls 'bx cli' and all plugins
- idt update : Runs this installer checking for and installing any updates
- idt uninstall : Uninstalls IDT, including the 'bx cli' and all plugins
If "uninstall", the IBM Cloud CLI and plugins are removed from the system, including personal metadata.
Note: Pre-req CLIs listed above are NOT uninstalled.
Chat with us on Slack: https://ibm.biz/IBMCloudNativeSlack
Submit any issues to : https://github.com/ibm-cloud-tools/idt-installer
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

By default, this installer will use the 'brew' installer if it is available. You can use the `--nobrew` argument to disable use of 'brew'. Note that you must be consistent with the use of `--nobrew` when installing, updating, and uninstalling.
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. If you run into any issues, please let us know on [Slack](https://ibm.biz/IBMCloudNativeSlack) or file an issue on our [GitHub repo](https://github.com/ibm-cloud-tools/idt-installer).
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](https://slack-invite-ibm-cloud-tech.mybluemix.net/) - #developer-tools channel, or file an issue on our [GitHub repo](https://github.com/IBM-Cloud/ibm-cloud-developer-tools/issues).


### Windows
Expand All @@ -127,13 +138,5 @@ This script has only been tested on Ubuntu Linux systems, although it should beh

## Internal IBM users

IBM users can utilize this installer pulling the Bluemix CLI and plugins from pre-release internal servers. In order to have the installer utilize internal servers, set the following environment variables (eg in `~/.bashrc`), substituting the proper internal URLs. Shown below are the default public URLs:

```
export IDT_INSTALL_USE_PROD=true
export IDT_INSTALL_BMX_URL="https://clis.ng.bluemix.net/install"
export IDT_INSTALL_BMX_REPO_NAME="internal"
export IDT_INSTALL_BMX_REPO_URL="https://plugins.ng.bluemix.net"
```
IBM users can use pre-release versions of the IDT (bx 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 bx CLI does not have extra plugin repos defined, it only applies during subsequent updates.

If you need assistance on the proper values, just ask in any of the IBM internal slack channels.
Loading

0 comments on commit 3fdacda

Please sign in to comment.