Skip to content

Commit 43f04aa

Browse files
updated README to include installation instructions
1 parent 2485945 commit 43f04aa

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,37 @@
66
This repository houses the code that powers the [ibmcloud-cli sl](https://github.ibm.com/Bluemix/bluemix-cli) command.
77
[CLI Documentation](https://pages.github.ibm.com/SoftLayer/softlayer-cli)
88

9-
# Project Setup
9+
## Installation (official)
10+
11+
The Classic Infrastructure commands are a plugin for the `ibmcloud` cli. First you need to [Install the IBMCLOUD CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli). Then simply install the `sl` plugin with the following command:
12+
13+
```bash
14+
ibmcloud plugin install sl
15+
```
16+
17+
To update, simply run
18+
19+
```bash
20+
ibmcloud plugin update sl
21+
```
22+
23+
## Installation (source build)
24+
25+
To install a version of the plugin built locally, you can do the following:
26+
27+
1. Build the `sl` plugin binary
28+
2. `go build`
29+
3. Install the new `softlayer` binary
30+
4. `ibmcloud plugin install ./softlayer` (might need to put `./softlayer.exe` for windows installs)
31+
32+
When building from source, the plugin gets its version information from `plugin/metadata/sl.go`. You may want to update that number to not get confused with official versions.
33+
34+
# Development Project Setup
1035

1136
Clone the repo, then just run `go mod vendor` and `go build` and you should have a running binary for the `sl` plugin.
1237

1338

14-
# Testing
39+
## Testing
1540
Before making a pull request, make sure everything looks good with these tools.
1641
Working directory: `$GO_PATH/src/github.ibm.com/SoftLayer/softlayer-cli`
1742

0 commit comments

Comments
 (0)