Skip to content
This repository has been archived by the owner on Apr 4, 2024. It is now read-only.

Commit

Permalink
Add extended examples for usage / upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
trevrosen authored Nov 15, 2023
1 parent 9e58ed2 commit 812c2f8
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,59 @@
# gh-attestation

**NOTE** this is the location of the gh-attestation extension during Private Beta and is subject to change once the Private Beta is over.
**NOTE**: this is the location of the gh-attestation extension during Private Beta and is subject to change once the Private Beta is over.

**OTHER NOTE**: command output in this README may look different from what is in the tool at runtime as we make minor changes.

## Installation
1. Install the [GH CLI tool](https://cli.github.com/)
2. Install this extension: `gh extension install github-early-access/gh-attestation`
2. Install this extension:

```shell
╰─$ gh ext install github-early-access/gh-attestation
✓ Installed extension github-early-access/gh-attestation
```

## Upgrading
We will be releasing new versions of the extension throughout the private beta. Upgrade as follows:

```shell
╰─$ gh ext upgrade github-early-access/gh-attestation
[attestation]: upgraded from v0.1.8 to v0.1.16
✓ Successfully upgraded extension
```

## Reporting version
When you file bugs, we will ask you to include a version string so we know what version of the tool you're on:

```shell
╰─$ gh attestation version
7f4f753-0.1.16 (2023-11-14)
```

## Usage
The CLI extension itself offers detailed information about usage.

To see a list of all subcommands:

`gh attestation`
```shell
╰─$ gh attestation
Work with attestations that represent trusted metadata about artifacts and images

Usage:
attestation [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
download Download trusted metadata about a binary artifact for offline use
help Help about any command
verify Cryptographically verify an artifact
version Print version of the tool

Flags:
-h, --help help for attestation

Use "attestation [command] --help" for more information about a command.
```

To see detailed usage information for a given subcommand:

Expand Down

0 comments on commit 812c2f8

Please sign in to comment.