Skip to content

Commit 897b610

Browse files
author
Philip Schmidt
committed
update README file to not include references to IDT cli and uninstaller
1 parent 17747e0 commit 897b610

4 files changed

Lines changed: 21 additions & 67 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@ The following command will install the IBM Cloud Developer Tools in a single inv
2222
$ curl -sL https://ibm.biz/idt-installer | bash
2323
```
2424

25-
Once complete, there will be three shortcuts defined to access the IBM Cloud Developer Tools:
26-
- `idt` : Main command line tool
27-
- `idt update` : Update your IBM Cloud Developer Tools to the latest versions
28-
- `idt uninstall` : Uninstall the IBM Cloud Developer Tools
25+
Once complete, there will be a shortcut defined to access the IBM Cloud CLI:
26+
- `ic` : Shortcut for the 'ibmcloud' command
27+
2928

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

linux-installer/README.md

Lines changed: 7 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ $ curl -sL https://ibm.biz/idt-installer | bash
3737

3838
Once complete, there will be three added shortcuts defined to access the IDT:
3939
- `ibmcloud dev` : Main command line tool for IBM cloud native development
40-
- `ibmcloud dev update` : Update your IDT environment to the latest versions
41-
- `ibmcloud dev uninstall` : Uninstall the IBM Developer Tools
40+
- `ibmcloud update` : Update your IBM Cloud CLI to the latest version
41+
- `ibmcloud plugin update` : Update IBM Cloud plugins to the latest versions
4242

4343

4444
### Debugging
@@ -49,44 +49,21 @@ If you have any issues with the installer, try running with the `--trace` argume
4949
curl -sL https://ibm.biz/idt-installer | bash -s -- --trace
5050
```
5151

52-
If updating an existing IDT installation, you can run the following:
52+
If you wish to update the IBM Cloud Dev Plugin, run:
5353
```
54-
idt update --trace
54+
ibmcloud plugin update dev --trace
5555
```
5656

5757

5858
## Updating
5959

60-
If you wish to update the IBM Developer Tools CLI, run `ibmcloud dev update`. There is also a `--force` argument that will force update to all dependencies too.
60+
If you wish to update the IBM Cloud Dev Plugin, run `ibmcloud plugin update dev`. There is also a `--force` argument that will force update to all dependencies too.
6161

6262
Syntax:
6363
```
64-
ibmcloud dev update [--force] [--trace]
64+
ibmcloud plugin update dev [--force] [--trace]
6565
```
6666

67-
This command is simply an alias defined during initial install that runs the installer shown here:
68-
69-
```
70-
$ curl -sL https://ibm.biz/idt-installer | bash -c -- [--force]
71-
```
72-
73-
74-
## Uninstall
75-
76-
If you wish to remove the IBM Developer Tools CLI, run `ibmcloud dev uninstall`.
77-
78-
Syntax:
79-
```
80-
ibmcloud dev uninstall [--trace]
81-
```
82-
83-
This command is simply an alias defined during install that runs the following:
84-
85-
```
86-
$ curl -sL https://ibm.biz/idt-installer | bash -c -- uninstall
87-
```
88-
89-
9067

9168
## Pre-Requisites
9269

@@ -103,7 +80,6 @@ Usage: idt-installer [<args>]
10380
10481
Where <args> is:
10582
install | update [Default] Perform full install (or update) of all needed CLIs and Plugins
106-
uninstall Uninstall full IBM Cloud CLI env, including 'ibmcloud', and plugins
10783
help | -h | -? Show this help
10884
--force Force updates of dependencies and other settings during update
10985
--trace Eanble verbose tracing of all activity
@@ -114,12 +90,8 @@ If "install" (or no action provided), a full CLI installation (or update) will o
11490
2. Install latest IBM Cloud 'ibmcloud' CLI
11591
3. Install all required plugins
11692
4. Defines aliases to improve useability
117-
- idt : Shortcut for normal "ibmcloud dev" command
118-
- idt update : Runs this installer checking for and installing any updates
119-
- idt uninstall : Uninstalls IDT, including the 'ibmcloud cli' and all plugins
93+
- ic : Shortcut for "ibmcloud" command
12094
121-
If "uninstall", the IBM Cloud CLI and plugins are removed from the system, including personal metadata.
122-
Note: Pre-req CLIs listed above are NOT uninstalled.
12395
12496
Chat with us on Slack: https://slack-invite-ibm-cloud-tech.mybluemix.net/
12597
Submit any issues to : https://github.com/IBM-Cloud/ibm-cloud-developer-tools/issues

windows-installer/README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
## Summary
1717

18-
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. 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.
18+
PowerShell script that downloads and installs the IBM Cloud CLI, plugins and all of its dependencies on Windows 10 or newer systems. The CLI 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.
1919

2020

2121
## Installation
@@ -29,10 +29,8 @@ This action will install (or update) the IBM Cloud Developer Tools to your windo
2929
Set-ExecutionPolicy Unrestricted; iex(New-Object Net.WebClient).DownloadString('http://ibm.biz/idt-win-installer')
3030
```
3131

32-
Once the installation has completed, and you have rebooted your system (as needed), there will be three added shortcuts defined to access the IDT:
33-
- `ibmcloud dev` : Main command line tool for IBM cloud native development
34-
- `ibmcloud dev update` : Update your IDT environment to the latest versions
35-
- `ibmcloud dev uninstall` : Uninstall the IBM Developer Tools
32+
Once the installation has completed, and you have rebooted your system (as needed), there will be an added shortcut defined to access the IBM Cloud cli:
33+
- `ic`: shortcut for the `ibmcloud` command
3634

3735

3836
### Running from Download
@@ -56,9 +54,9 @@ Set-ExecutionPolicy Unrestricted
5654
.\idt-win-installer.ps1 --trace
5755
```
5856

59-
If updating an existing IDT installation, you can run the following:
57+
If updating an existing IBM Cloud CLI installation, you can run the following:
6058
```
61-
ibmcloud dev update --trace
59+
ibmcloud update --trace
6260
```
6361

6462

@@ -67,7 +65,7 @@ ibmcloud dev update --trace
6765
If you wish to update the IBM Developer Tools CLI, run:
6866

6967
```
70-
ibmcloud dev update [--force] [--trace]
68+
ibmcloud plugin update dev [--force] [--trace]
7169
```
7270

7371
The `--force` argument that will force update to all dependencies too.
@@ -78,20 +76,6 @@ This command is simply a shortcut defined during initial install that runs (in a
7876
PowerShell -NoProfile -ExecutionPolicy Unrestricted -Command "& {Start-Process PowerShell -ArgumentList '-NoProfile -ExecutionPolicy Unrestricted ""iex(New-Object Net.WebClient).DownloadString(""""http://ibm.biz/idt-win-installer"""")"" ""%2"" ""%3"" ' -Verb RunAs}"
7977
```
8078

81-
## Uninstall
82-
83-
If you wish to remove the IBM Developer Tools CLI, run:
84-
85-
```
86-
ibmcloud dev uninstall [--trace]
87-
```
88-
89-
This command is simply a shortcut defined during install that runs (in admin mode) the installer's uninstall action as shown here:
90-
91-
```
92-
PowerShell -NoProfile -ExecutionPolicy Unrestricted -Command "& {Start-Process PowerShell -ArgumentList '-NoProfile -ExecutionPolicy Unrestricted ""iex(New-Object Net.WebClient).DownloadString(""""http://ibm.biz/idt-win-installer"""")"" ""uninstall"" ""%2"" ' -Verb RunAs}"
93-
```
94-
9579

9680
## Pre-Requisites
9781

@@ -108,7 +92,6 @@ Usage: idt-win-installer [<args>]
10892
10993
Where <args> is:
11094
install | update [Default] Perform full install (or update) of all needed CLIs and Plugins
111-
uninstall Uninstall full IBM Cloud CLI env, including 'ibmcloud', and plugins
11295
help | -h | -? Show this help
11396
--force Force updates of dependencies and other settings during update
11497
--trace Eanble verbose tracing of all activity
@@ -119,12 +102,8 @@ If "install" (or no action provided), a full CLI installation (or update) will o
119102
2. Install latest IBM Cloud 'ibmcloud' CLI
120103
3. Install all required plugins
121104
4. Defines aliases to improve useability
122-
- idt : Shortcut for normal "ibmcloud dev" command
123-
- idt update : Runs this installer checking for and installing any updates
124-
- idt uninstall : Uninstalls IDT, including the 'ibmcloud cli' and all plugins
105+
- ic : Shortcut for "ibmcloud" command
125106
126-
If "uninstall", the IBM Cloud CLI and plugins are removed from the system, including personal metadata.
127-
Note: Pre-req CLIs listed above are NOT uninstalled.
128107
129108
Chat with us on Slack: https://slack-invite-ibm-cloud-tech.mybluemix.net/
130109
Submit any issues to : https://github.com/IBM-Cloud/ibm-cloud-developer-tools/issues

windows-installer/idt-win-installer.ps1

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,10 @@ function env_setup() {
272272
Write-Output "Creating 'ic' script to act as shortcut to 'ibmcloud' command..."
273273
$ic_batch = @"
274274
@ECHO OFF
275+
REM #-----------------------------------------------------------
276+
REM # IBM Cloud Shortcut
277+
REM # Shortcut for 'ibmcloud' command
278+
REM #-----------------------------------------------------------
275279
ibmcloud %*
276280
"@
277281
$ic_command = 'C:\Program Files\IBM\Cloud\bin\ic.bat'

0 commit comments

Comments
 (0)