Skip to content

chore: udpate install instructions #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matoous merged 1 commit into from
Sep 25, 2026
Merged

chore: udpate install instructions #159

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,20 @@ Command line tool for interacting with SumUp APIs.

SumUp CLI tool allows you to manage your SumUp account, create checkouts, and much more all from your terminal.

## Getting started
## Getting Started

### Install with Homebrew
### Installation

Choose one of the following installation methods:

```bash
# Homebrew
brew install sumup/cli/sumup
```

### Install with Go
# mise
mise use -g github:sumup/sumup-cli@latest

```bash
# Go
go install github.com/sumup/sumup-cli/cmd/sumup
```

Expand All @@ -31,7 +34,7 @@ The CLI expects an API key via the `SUMUP_API_KEY` environment variable by defau
export SUMUP_API_KEY=your_api_key
```

## Shell completion
## Shell Completion

Generate a completion script for your shell and load it:

Expand All @@ -48,7 +51,7 @@ sumup completion fish > ~/.config/fish/completions/sumup.fish

Release archives also include pre-generated bash, zsh, and fish completion scripts plus a man page (`man/man1/sumup.1.gz`).

## Managing merchant context
## Managing Merchant Context

To avoid repeating the `--merchant-code` flag in every command, you can set a merchant context:

Expand All @@ -65,7 +68,7 @@ sumup context unset

Once set, all commands that accept `--merchant-code` will use the context value by default. You can still override it by providing the flag explicitly.

## Create a checkout
## Create a Checkout

```bash
sumup checkouts create \
Expand All @@ -80,7 +83,7 @@ sumup checkouts create \
--purpose "Event"
```

## Manage readers
## Manage Readers

List readers for a merchant:

Expand Down Expand Up @@ -132,7 +135,7 @@ sumup readers status \
reader_42
```

## OpenAPI command coverage
## OpenAPI Command Coverage

The CLI keeps its user-facing command implementations handwritten, but derives
an operation catalog from the OpenAPI document shipped with the exact
Expand All @@ -150,7 +153,7 @@ definition. Tests enforce a one-to-one relationship between the pinned SDK,
the generated catalog, and the CLI command tree, so an SDK upgrade fails CI
until every new endpoint has exactly one corresponding command.

### Developer portal code samples
### Developer Portal Code Samples

Generate a deterministic, portal-compatible JSON catalog containing one CLI
code sample for every OpenAPI operation exposed by the CLI:
Expand Down
Loading