Skip to content

Commit f626cbd

Browse files
Karl BishopKarl Bishop
authored andcommitted
Added support for Jetbrains IDEs
1 parent 8399271 commit f626cbd

7 files changed

Lines changed: 80 additions & 10 deletions

File tree

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# IBM Cloud Developer Tools
22

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

7-
These scripts perform an installation of the IBM Cloud Developer Tools CLI environment. The IDT is a collection of tools to aid in IBM Cloud native development. They currently consist of the 'dev' plugin to the IBM Bluemix CLI, as well as the [IBM Developer Tools extension](https://marketplace.visualstudio.com/items?itemName=IBM.ibm-developer) to the [Visual Studio Code editor](https://code.visualstudio.com/). These tools work for the following environments:
7+
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.
8+
9+
These tools work for the following environments:
810
- [IBM **Cloud** Public](https://www.ibm.com/cloud-computing/)
911
- [IBM **Cloud** Private](https://www.ibm.com/cloud-computing/products/ibm-cloud-private/)
1012
- [IBM **Cloud** Dedicated](https://www.ibm.com/cloud-computing/bluemix/dedicated)
@@ -14,7 +16,7 @@ If you run into any issues, please let us know on the [IBM Cloud Tech Slack :: #
1416

1517

1618

17-
## MacOS & Linux Installation
19+
## IDT MacOS & Linux Installation
1820

1921
The following command will install the IBM Cloud Developer Tools in a single invocation. Open up a terminal and run the following command:
2022

@@ -40,7 +42,7 @@ Access the [platform-specific readme](./linux-installer/README.md) for additiona
4042

4143

4244

43-
## Windows Installation
45+
## IDT Windows Installation
4446

4547
To install the IBM Cloud Developer Tools CLI on Windows 10 or newer:
4648

@@ -53,11 +55,20 @@ Set-ExecutionPolicy Unrestricted; iex(New-Object Net.WebClient).DownloadString('
5355
Access the [Widnows-specific readme](./windows-installer/README.md) for additional details.
5456

5557

58+
## 3rd Party IDE Extensions
59+
60+
The following IDE extensions are available to enable access to IDT CLI directly from eithin the IDE.
61+
62+
- [Visual Studio Code](https://code.visualstudio.com/) editor - [IBM Developer Tools extension](https://marketplace.visualstudio.com/items?itemName=IBM.ibm-developer)
63+
- [Jetbrains](https://www.jetbrains.com) based IDEs (IntelliJ, WebStorm, Android Studio, etc) - [External Tools Settings](./jetbrains)
64+
65+
Notice: These extensions are provided "as-is". IBM does not explicitly endorse, nor support these 3rd party products. Although we will attempt to answer questions through our Slack channel, because we want you to succeed and be happy.
66+
67+
5668

5769
## Feedback
5870

5971
We can be reached in the following ways. We encourage and welcome all feedback and suggestions
6072
- [IBM Cloud Tech Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/): Find us on the `#developer-tools` channel
61-
- [IBM Cloud Developer Tools GitHub repo](https://github.com/IBM-Bluemix/ibm-cloud-developer-tools): Use to file any issues specific to installation of the tools
62-
- [IBM Cloud Ideas portal](http://ibm.biz/cloudideas): Use to view and submit new feature ideas for the IBM Cloud
73+
- [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
6374

jetbrains/README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# IBM Cloud Developer Tools CLI - Helper for Jetbrains IDEs
2+
3+
[![](https://img.shields.io/badge/IBM%20Cloud-powered-blue.svg)](https://bluemix.net)
4+
5+
### Table of Contents
6+
* [Summary](#summary)
7+
* [Installation](#installation)
8+
* [Usage](#usage)
9+
* [Uninstall](#uninstall)
10+
* [Feedback](#feedback)
11+
12+
13+
## Summary
14+
15+
This settings JAR file can be imported into any of the [Jetbrains](https://www.jetbrains.com) based IDEs -- IntelliJ, WebStorm, Android Studio, etc -- that will provide a Tools menu entry to call IDT actions from within the IDE.
16+
17+
![IDT tools within WebStorm](./idt-jetbrains.png)
18+
19+
Notice: This helper is provided as-is. IBM does not explicitly endorse, nor support 3rd party products. We will attempt to answer questions through our Slack channel, because we want you to succeed and be happy.
20+
21+
22+
## Installation
23+
24+
Note: You must have previously [installed](../README.md) the IBM Developer Tools CLI.
25+
26+
1. Download the [idt-jetbrains-settings.jar](idt-jetbrains-settings.jar) file
27+
1. Open your preferred [Jetbrains IDE](https://www.jetbrains.com)
28+
1. Select `File` > `Import Settings`, then locate the downloaded *idt-settings.jar* file.
29+
30+
Once complete, there will be a new "IBM Cloud Developer Tools" entry under the following menus:
31+
- Main "Tools" menu
32+
- Editor context (right-click) menu
33+
- Project context menu
34+
- Search results
35+
36+
37+
## Usage
38+
39+
You can either start with an existing server-side app, and `Enable` it for the IBM Cloud, or use the IDT CLI to `Create` a new app from a StarterKit (`bx dev create`). Once you have your app's project, open it in your JetBrains IDE.
40+
41+
If you have a generic server-side app, select `Tools` > `IBM Cloud Developer Tools` > `Enable app for IBM Cloud`. This will check for, and add all required files to enable you to build the app locally, as well as deploy it to IBM Cloud using either as a Cloud Foundry app, or within a Kubernetes cluster.
42+
43+
Develop your cloud native app as normal, using the basic build/run/deploy actions from the IDT menu. If you need to perform actions that are not in the menu, simply open the Terminal tab and enter the desired commands manually.
44+
45+
For more information, see the [IBM Cloud Developer Tools documentation](https://console.bluemix.net/docs/cloudnative/dev_cli.html).
46+
47+
48+
49+
## Uninstall
50+
51+
If you wish to remove the IBM Developer Tools CLI helper, simply go into `Preferences` > `Tools` > `External Tools`, and then select and delete (minus sign) each entry under the "IBM Cloud Developer Tools" group. The group itself is removed once the final entry is deleted.
52+
53+
54+
## Feedback
55+
56+
We can be reached in the following ways. We encourage and welcome all feedback and suggestions
57+
- [IBM Cloud Tech Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/): Find us on the `#developer-tools` channel
58+
- [IBM Cloud Developer Tools GitHub repo](https://github.com/IBM-Cloud/ibm-cloud-developer-tools): Use to file any issues specific to this Jetbrains helper
59+
1.18 KB
Binary file not shown.

jetbrains/idt-jetbrains.png

598 KB
Loading

linux-installer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IBM Developer Tools CLI Installer (idt-installer)
22

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

66
### Table of Contents

linux-installer/idt-installer

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
# Copyright (c) 2017, International Business Machines. All Rights Reserved.
88
#------------------------------------------------------------------------------
99

10-
VERSION="1.0.1"
10+
VERSION="1.1.0"
1111
PROG="IBM Cloud Developer Tools - Installer"
1212
INSTALLER_URL="https://ibm.biz/idt-installer"
13-
GIT_URL="https://github.com/IBM-Bluemix/ibm-cloud-developer-tools"
13+
GIT_URL="https://github.com/IBM-Cloud/ibm-cloud-developer-tools"
1414
SLACK_URL="https://slack-invite-ibm-cloud-tech.mybluemix.net/"
1515
DEFAULT_BMX_URL="https://clis.ng.bluemix.net/install"
1616

windows-installer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
PowerShell script that downloads and installs the IBM Cloud Developer Tools (IDT) CLI Plugin and all of its dependencies on Windows 10 or newer systems.
44

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

88
## Single-line Running

0 commit comments

Comments
 (0)