Skip to content

Commit

Permalink
documentation: Update the installation options (#979)
Browse files Browse the repository at this point in the history
#### What this PR does / why we need it

Update the installation possibilities as they are supported right now.

#### Which issue(s) this PR fixes

closes #856
  • Loading branch information
hilmarf authored and Skarlso committed Oct 22, 2024
1 parent fb2292e commit e5914ad
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 11 deletions.
1 change: 1 addition & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ newcomponentaccess
newcomponentversionaccess
newrepository
newrepositoryspec
nixos
npm
npmjs
npmrc
Expand Down
52 changes: 41 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,16 @@ The OCI and OCM support can be found in packages

## Installation

Install the latest release from any of
Install the latest release with

- [Homebrew](https://brew.sh)
- [Nix](https://nixos.org)
- [AUR](https://aur.archlinux.org/packages/ocm-cli)
- [Docker](https://www.docker.com/)
- [Podman](https://podman.io/)
- [GitHub Releases](https://github.com/open-component-model/ocm/releases)
- [Bash](#bash)
- [Homebrew](#homebrew)
- [NixOS](#nixos)
- [AUR](#aur)
- [Container](#container)
- [Chocolatey](#chocolatey)
- [Winget](#winget)
- [GitHub Releases](https://github.com/open-component-model/ocm/releases/latest)

### Bash

Expand All @@ -64,14 +66,18 @@ To install with `bash` for macOS or Linux execute the following command:
curl -s https://ocm.software/install.sh | sudo bash
```

### Install using Homebrew
### Homebrew

Install using [Homebrew](https://brew.sh)

```bash
# Homebrew (macOS and Linux)
brew install open-component-model/tap/ocm
```

### Install using Nix (with [Flakes](https://nixos.wiki/wiki/Flakes))
### NixOS

Install using [Nix](https://nixos.org) (with [Flakes](https://nixos.wiki/wiki/Flakes))

```bash
# Nix (macOS, Linux, and Windows)
Expand All @@ -91,7 +97,9 @@ nix profile list | grep ocm
ocm --help
```

### Install from AUR (Arch Linux User Repository)
### AUR

Install from [AUR (Arch Linux User Repository)](https://archlinux.org/)

package-url: [aur.archlinux.org/packages/ocm-cli](https://aur.archlinux.org/packages/ocm-cli)

Expand All @@ -104,7 +112,13 @@ makepkg -i

[AUR Documentation](https://wiki.archlinux.org/title/Arch_User_Repository)

### Usage via Docker / Podman
### Container

Usage via [Docker](https://www.docker.com/) / [Podman](https://podman.io/)

```bash
docker run -t ghcr.io/open-component-model/ocm:latest --help
```

```bash
podman run -t ghcr.io/open-component-model/ocm:latest --help
Expand Down Expand Up @@ -135,6 +149,22 @@ Please check [hub.docker.com](https://hub.docker.com/_/golang/tags?page=1&name=a
podman build -t ocm --build-arg GO_VERSION=1.23 --build-arg ALPINE_VERSION=3.20 --build-arg GO_PROXY=https://proxy.golang.org .
```

### Chocolatey

```powershell
choco install ocm-cli
```

see: [chocolatey community package: ocm-cli](https://community.chocolatey.org/packages/ocm-cli)

### Winget

```powershell
winget install ocm-cli
```

see: [microsoft/winget-packages: Open-Component-Model](https://github.com/microsoft/winget-pkgs/tree/master/manifests/o/Open-Component-Model)

## Examples

An example of how to use the `ocm` CLI in a Makefile can be found in [`examples/make`](examples/make/Makefile).
Expand Down

0 comments on commit e5914ad

Please sign in to comment.