Skip to content

Commit

Permalink
add an installation appendix. Fixes #75 (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicks authored Mar 16, 2021
1 parent 19251ce commit 4bbedc1
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 4 deletions.
50 changes: 50 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# ctlptl Installation Appendix

## Recommended

### Homebrew (Mac/Linux)

```
brew install tilt-dev/tap/ctlptl
```

### Scoop (Windows)

```
scoop bucket add tilt-dev https://github.com/tilt-dev/scoop-bucket
scoop install ctlptl
```

## Alternative

### Point and click

Visit [the releases page](https://github.com/tilt-dev/ctlptl/releases) and
download the pre-build binaries for your architecture.

### Command-line

On macOS:

```bash
export CTLPTL_VERSION="0.4.2"
curl -fsSL https://github.com/tilt-dev/ctlptl/releases/download/v$CTLPTL_VERSION/ctlptl.$CTLPTL_VERSION.mac.x86_64.tar.gz | tar -xzv ctlptl && \
sudo mv ctlptl /usr/local/bin/ctlptl
```

On Linux:

```bash
export CTLPTL_VERSION="0.4.2"
curl -fsSL https://github.com/tilt-dev/ctlptl/releases/download/v$CTLPTL_VERSION/ctlptl.$CTLPTL_VERSION.linux.x86_64.tar.gz | tar -xzv ctlptl && \
sudo mv ctlptl /usr/local/bin/ctlptl
```

On Windows:

```powershell
$CTLPTL_VERSION = "0.4.2"
Invoke-WebRequest "https://github.com/tilt-dev/ctlptl/releases/download/v$CTLPTL_VERSION/ctlptl.$CTLPTL_VERSION.windows.x86_64.zip" -OutFile "ctlptl.zip"
Expand-Archive "ctlptl.zip" -DestinationPath "ctlptl"
Move-Item -Force -Path "ctlptl\ctlptl.exe" -Destination "$home\bin\ctlptl.exe"
```
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Maybe you need a `ctlptl`.

## What is ctlptl?

`ctlptl` (pronounced "cattle paddle") is a CLI for declaratively setting up
`ctlptl` (pronounced "coddle poodle") is a CLI for declaratively setting up
local Kubernetes clusters.

Inspired by `kubectl` and
Expand All @@ -37,9 +37,10 @@ scoop bucket add tilt-dev https://github.com/tilt-dev/scoop-bucket
scoop install ctlptl
```

### Manually (Mac/Linux/Windows)
### Alternative Options

Download the pre-compiled binaries from the [releases](https://github.com/tilt-dev/ctlptl/releases) page and copy to the desired location.
If automatic installers aren't your cup of tea, check out the [installation
appendix](INSTALL.md) for more options.

## How do I use it?

Expand Down Expand Up @@ -175,7 +176,7 @@ We expect everyone -- users, contributors, followers, and employees alike -- to

- To help infra engineers manage a consistent dev environment

- To encourage standards that enable interop between devtools, lke [KEP 1755](https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/generic/1755-communicating-a-local-registry)
- To encourage standards that enable interop between devtools, like [KEP 1755](https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/generic/1755-communicating-a-local-registry)

## Non-Goals

Expand Down

0 comments on commit 4bbedc1

Please sign in to comment.